xontrib-syslog-shell-profiler 0.1.0

A Xonsh plugin to profile and log command execution to a syslog file.

A Xonsh plugin to profile and log command execution to a syslog file.

Installation

TODO

Usage

xontrib load syslog-shell-profiler
$XONSH_HISTORY_BACKEND = JsonSyslogHistory

TODELETE

xontrib promotion (READ and REMOVE THIS SECTION)

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 add keys PYPI_USERNAME and PYPI_PASSWORD.
3. Click "Actions" link on your Github repository.
4. Click "Set up this workflow" on "Publish Python Action".
5. Commit the config without any changes.
6. 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.json.