Format xonsh history to post it to Github or another page.
Project description
Format xonsh history to post it to Github or another page.
The mission of xontrib-hist-format is to make commands repeatable, copy-pastable and save time to preparing.
If you like the idea click ⭐ on the repo and stay tuned.
Installation
xpip install xontrib-hist-format
# or: xpip install -U git+https://github.com/anki-code/xontrib-hist-format
Usage
xontrib load hist_format
hist-format --help # Basic command
hist-md # Markdown format shortcut
hist-txt # Text format shortcut
Arguments:
usage: hist-format [-h] [-f FORMAT] [-c COMMANDS_COUNT] [-l]
[-H [OUTPUT_HEAD_COUNT]] [-T [OUTPUT_TAIL_COUNT]]
[-m] [--lines]
Format xonsh history to post it to Github or another page.
optional arguments:
-h, --help show this help message and exit
-f FORMAT, --format FORMAT
Format: md, txt.
-c COMMANDS_COUNT, --commands-count COMMANDS_COUNT
Count of commands
-l, --commands-list Show commands in distinct section.
-H [OUTPUT_HEAD_COUNT], --output-head-count [OUTPUT_HEAD_COUNT]
Count of lines from output head to show.
-T [OUTPUT_TAIL_COUNT], --output-tail-count [OUTPUT_TAIL_COUNT]
Count of lines from output tail to show.
-m, --min Make block minimized i.e. by adding <details> tag in Markdown.
--lines Add additional lines before and after.
Note! The clear
command is used as marker of the beginning of commands list. If you run commands 1, 2, 3
then run clear
, and run 4, 5, 6 and finally run hist-md
it will show 4, 5, 6 commands.
Feel free to open an issue with feedback on this approach.
Example
Run commands:
echo 123
ls / | head -n 3
Run hist-format:
hist-md -c 2 -l --lines # latest 2 commands + commands list + header and footer as line
As result you will get the output that you can copy and paste to the Github comment or md-file:
Output:
echo 123
#123
ls / | head -n 3
#boot
#cdrom
#dev
# Prepared by xontrib-hist-format
Commands:
echo 123
ls / | head -n 3
# Prepared by xontrib-hist-format
Clipboard
You can redirect the output to clipboard. Example for xclip:
hist-md | xclip
Known issues
Not every command has output in the __xonsh__.history
. Workaround in some cases is to use pipe into head
i.e. cat file | head
.
Credits
- This package is the part of ergopack - the pack of ergonomic xontribs.
- This package was created with xontrib cookiecutter template.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for xontrib-hist-format-0.0.12.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f808a318e1456bcc346b0109a1d1e45f4fe72c32637adede83e8879b9edc4eaa |
|
MD5 | af32989d86465b2c2b17128938566358 |
|
BLAKE2b-256 | 448c9495a36564cd768e27b8aa6de18d2ee4d2d0314a9fef0a2245043d1979d0 |
Hashes for xontrib_hist_format-0.0.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0416771b6d2e40db1dde555abd6126b2300be12cfeb773af980d8164609ae640 |
|
MD5 | fc44457ef8b8fdbd803a933967fd93b7 |
|
BLAKE2b-256 | 2a22db7c5f52389f318c2e178965cbbe4a3a3899eca83072822799c6374f7960 |