Skip to content

theRealBithive/init-sshagent

Repository files navigation

Initializes the SSH Agent and export the environment variable

If you like the idea click ⭐ on the repo and tweet.

Installation

To install use pip:

xpip install xontrib-init-ssh-agent
# or: xpip install -U git+https://github.com/theRealBithive/

Usage

xontrib load init_ssh_agent
# TODO: what's next?

Examples

...

Known issues

...

Credits

This package was created with xontrib cookiecutter template.


READ and REMOVE THIS SECTION

Releasing your package

  • Bump the version of your package.
  • Create a GitHub release (The release notes are automatically generated as a draft release after each push).
  • And publish with poetry publish --build or twine

Promotion of your xontrib

After you create the xontrib repository you can do some helpful tasks to spread the word about your xontrib.

Repository name. It's a good practice to add xontrib- prefix before the name of your repository. It helps Github search find it.

Add topics to the repository. To show the xontrib repository in Github Topics please add topics xonsh and xontrib to the repository "About" setting. Also add thematic topics, for example, ssh if your xontrib helps work with ssh.

Easiest way to publish your xontrib to PyPi via Github Actions. Users can install your xontrib via pip install xontrib-myxontrib. Easiest way to achieve it is to use Github Actions:

  1. Register to https://pypi.org/ and create API token.
  2. Go to repository "Settings" - "Secrets" and your PyPI API token as PYPI_API_TOKEN as a "Repository Secret".
  3. Click "Actions" link on your Github repository.
    1. Click on "New Workflow"
    2. Click "Configure" on "Publish Python Package" Action.
  4. Commit the config without any changes.
  5. Now when you create new Release the Github Actions will publish the xontrib to PyPi automatically. Release status will be in Actions sction.

Add preview image. Add the image to repository "Settings" - "Options" - "Social preview". It allows to show preview image in Github Topics and social networks.

Add xontrib to the xonsh. To show xontrib name in xontrib list in xonsh add it to the xonsh/xontribs_meta.py.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages