From 9079ecfcda6829311ff227660723a0cee8471bec Mon Sep 17 00:00:00 2001 From: Daylin Morgan Date: Tue, 8 Aug 2023 16:38:23 -0500 Subject: [PATCH] docs: update svgs --- docs/svgs/viv-cache-help.svg | 64 ++++++++--------- docs/svgs/viv-cache-info-help.svg | 64 +++++++++-------- docs/svgs/viv-cache-remove-help.svg | 56 ++++++++------- docs/svgs/viv-list-help.svg | 90 ++++++++++++------------ docs/svgs/viv-manage-help.svg | 72 ++++++++------------ docs/svgs/viv-manage-install-help.svg | 62 +++++++++-------- docs/svgs/viv-manage-purge-help.svg | 62 +++++++++-------- docs/svgs/viv-manage-show-help.svg | 48 +++++++------ docs/svgs/viv-manage-update-help.svg | 62 +++++++++-------- docs/svgs/viv-run-help.svg | 98 ++++++++++++++------------- 10 files changed, 353 insertions(+), 325 deletions(-) diff --git a/docs/svgs/viv-cache-help.svg b/docs/svgs/viv-cache-help.svg index ec3d67a..beb14c3 100644 --- a/docs/svgs/viv-cache-help.svg +++ b/docs/svgs/viv-cache-help.svg @@ -1,4 +1,4 @@ - + - - + + - + - + - + - + - + - + - + - + - - - - - - - viv cache --help + viv cache --help - + - - usage: viv cache [-h] <sub-cmd> ... - -manage the viv vivenv cache - -options: --h, --help    show this help message and exit - -subcommand: -<sub-cmd> -info (i)    get metadata about a vivenv -remove (r)  remove a vivenv + + usage: viv cache [-h] <sub-cmd> ... + +manage the viv vivenv cache + +options: +-h, --help    show this help message and exit + +subcommand: +<sub-cmd> diff --git a/docs/svgs/viv-cache-info-help.svg b/docs/svgs/viv-cache-info-help.svg index e85c6c4..3a91bc9 100644 --- a/docs/svgs/viv-cache-info-help.svg +++ b/docs/svgs/viv-cache-info-help.svg @@ -1,4 +1,4 @@ - + - - + + - + - + - + - + - + - + - + - + + + + + + + - viv cache info --help + viv cache info --help - + - - usage: viv cache info [-h] [-p] [--json] vivenv - -positional arguments: -vivenv        name/hash of vivenv - -options: --h, --help    show this help message and exit --p, --path    print the absolute path to the vivenv ---json        name:metadata json for vivenvs + + usage: viv cache info [-h] [-p] [--json] vivenv + +get metadata about a vivenv + +positional arguments: +vivenv        name/hash of vivenv + +options: +-h, --help    show this help message and exit +-p, --path    print the absolute path to the vivenv +--json        name:metadata json for vivenvs diff --git a/docs/svgs/viv-cache-remove-help.svg b/docs/svgs/viv-cache-remove-help.svg index ef7efbe..58a80f8 100644 --- a/docs/svgs/viv-cache-remove-help.svg +++ b/docs/svgs/viv-cache-remove-help.svg @@ -1,4 +1,4 @@ - + - - + + - + - + - + - + - + - + + + + + + + - viv cache remove --help + viv cache remove --help - + - - usage: viv cache remove [-h] [vivenv ...] - -positional arguments: -vivenv        name/hash of vivenv - -options: --h, --help    show this help message and exit + + usage: viv cache remove [-h] [vivenv ...] + +remove a vivenv + +positional arguments: +vivenv        name/hash of vivenv + +options: +-h, --help    show this help message and exit diff --git a/docs/svgs/viv-list-help.svg b/docs/svgs/viv-list-help.svg index 194e649..57eb106 100644 --- a/docs/svgs/viv-list-help.svg +++ b/docs/svgs/viv-list-help.svg @@ -19,14 +19,14 @@ font-weight: 700; } - .terminal-2405883704-matrix { + .terminal-288284702-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-2405883704-title { + .terminal-288284702-title { font-size: 18px; font-weight: bold; font-family: arial; @@ -36,97 +36,97 @@ -webkit-filter: drop-shadow( 2px 5px 2px rgba(0, 0, 0, .7)); filter: drop-shadow( 2px 5px 2px rgba(0, 0, 0, .7)); } - .terminal-2405883704-r1 { fill: #94e2d5;font-weight: bold } -.terminal-2405883704-r2 { fill: #c6d0f5 } -.terminal-2405883704-r3 { fill: #f9e2af;font-weight: bold } -.terminal-2405883704-r4 { fill: #f9e2af } + .terminal-288284702-r1 { fill: #94e2d5;font-weight: bold } +.terminal-288284702-r2 { fill: #c6d0f5 } +.terminal-288284702-r3 { fill: #f9e2af;font-weight: bold } +.terminal-288284702-r4 { fill: #f9e2af } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - viv list --help + viv list --help - + - - usage: viv list [-h] [-v] [-q] [-f <key:value>] [--json] - -list vivenvs - -examples: -  `viv list \ -      --filter "accessed-after:2023-08-01"` -  `viv list -q --filter \ -    "created-before:$(date -d '2 weeks ago' +'%Y-%m-%d')"` -  `viv list --filter "file:./script.py"` -  `viv list --filter "file:None"` - -options: --h, --help                  show this help message and exit --v, --verbose               pretty print full metadata for vivenvs --q, --quiet                 show only ids --f, --filter <key:value>    filter vivenvs based on key:val ---json                      name:metadata json for vivenvs + + usage: viv list [-h] [-v] [-q] [-f <key:value>] [--json] + +list vivenvs + +examples: +  `viv list \ +      --filter "accessed-after:2023-08-01"` +  `viv list -q --filter \ +    "created-before:$(date -d '2 weeks ago' +'%Y-%m-%d')"` +  `viv list --filter "files:./script.py"` +  `viv list --filter "files:None"` + +options: +-h, --help                  show this help message and exit +-v, --verbose               pretty print full metadata for vivenvs +-q, --quiet                 show only ids +-f, --filter <key:value>    filter vivenvs based on key:val +--json                      name:metadata json for vivenvs diff --git a/docs/svgs/viv-manage-help.svg b/docs/svgs/viv-manage-help.svg index 254d133..ab18d0f 100644 --- a/docs/svgs/viv-manage-help.svg +++ b/docs/svgs/viv-manage-help.svg @@ -1,4 +1,4 @@ - + - - + + - + - + - + - + - + - + - + - + - - - - - - - - - - - - - viv manage --help + viv manage --help - + - - usage: viv manage [-h] <sub-cmd> ... - -manage viv itself - -options: --h, --help     show this help message and exit - -subcommand: -<sub-cmd> -show (s)     show current installation -install (i)  install fresh viv -update (u)   update viv version -purge (p)    remove traces of viv + + usage: viv manage [-h] <sub-cmd> ... + +manage viv itself + +options: +-h, --help    show this help message and exit + +subcommand: +<sub-cmd> diff --git a/docs/svgs/viv-manage-install-help.svg b/docs/svgs/viv-manage-install-help.svg index 32dc31d..eedcf58 100644 --- a/docs/svgs/viv-manage-install-help.svg +++ b/docs/svgs/viv-manage-install-help.svg @@ -1,4 +1,4 @@ - + - - + + - + - + - + - + - + - + - + + + + + + + - viv manage install --help + viv manage install --help - + - - usage: viv manage install [-h] [-r <ref>] [-s <path>] [-c <path>] [-y] - -options: --h, --help          show this help message and exit --r, --ref <ref>     git reference (branch/tag/commit) --s, --src <path>    path/to/source_file --c, --cli <path>    path/to/cli (symlink to src) --y, --yes           respond yes to all prompts + + usage: viv manage install [-h] [-r <ref>] [-s <path>] [-c <path>] [-y] + +install fresh viv + +options: +-h, --help          show this help message and exit +-r, --ref <ref>     git reference (branch/tag/commit) +-s, --src <path>    path/to/source_file +-c, --cli <path>    path/to/cli (symlink to src) +-y, --yes           respond yes to all prompts diff --git a/docs/svgs/viv-manage-purge-help.svg b/docs/svgs/viv-manage-purge-help.svg index 2fb0ff7..c9fc5f7 100644 --- a/docs/svgs/viv-manage-purge-help.svg +++ b/docs/svgs/viv-manage-purge-help.svg @@ -1,4 +1,4 @@ - + - - + + - + - + - + - + - + - + - + + + + + + + - viv manage purge --help + viv manage purge --help - + - - usage: viv manage purge [-h] [-r <ref>] [-s <path>] [-c <path>] [-y] - -options: --h, --help          show this help message and exit --r, --ref <ref>     git reference (branch/tag/commit) --s, --src <path>    path/to/source_file --c, --cli <path>    path/to/cli (symlink to src) --y, --yes           respond yes to all prompts + + usage: viv manage purge [-h] [-r <ref>] [-s <path>] [-c <path>] [-y] + +remove traces of viv + +options: +-h, --help          show this help message and exit +-r, --ref <ref>     git reference (branch/tag/commit) +-s, --src <path>    path/to/source_file +-c, --cli <path>    path/to/cli (symlink to src) +-y, --yes           respond yes to all prompts diff --git a/docs/svgs/viv-manage-show-help.svg b/docs/svgs/viv-manage-show-help.svg index 96aa69f..a92163f 100644 --- a/docs/svgs/viv-manage-show-help.svg +++ b/docs/svgs/viv-manage-show-help.svg @@ -1,4 +1,4 @@ - + - - + + - + - + - + - + + + + + + + - viv manage show --help + viv manage show --help - + - - usage: viv manage show [-h] [-p] - -options: --h, --help          show this help message and exit --p, --pythonpath    show the path/to/install + + usage: viv manage show [-h] [-p] + +show current installation + +options: +-h, --help          show this help message and exit +-p, --pythonpath    show the path/to/install diff --git a/docs/svgs/viv-manage-update-help.svg b/docs/svgs/viv-manage-update-help.svg index 9d11b0d..6f1dfb0 100644 --- a/docs/svgs/viv-manage-update-help.svg +++ b/docs/svgs/viv-manage-update-help.svg @@ -1,4 +1,4 @@ - + - - + + - + - + - + - + - + - + - + + + + + + + - viv manage update --help + viv manage update --help - + - - usage: viv manage update [-h] [-r <ref>] [-s <path>] [-c <path>] [-y] - -options: --h, --help          show this help message and exit --r, --ref <ref>     git reference (branch/tag/commit) --s, --src <path>    path/to/source_file --c, --cli <path>    path/to/cli (symlink to src) --y, --yes           respond yes to all prompts + + usage: viv manage update [-h] [-r <ref>] [-s <path>] [-c <path>] [-y] + +update viv version + +options: +-h, --help          show this help message and exit +-r, --ref <ref>     git reference (branch/tag/commit) +-s, --src <path>    path/to/source_file +-c, --cli <path>    path/to/cli (symlink to src) +-y, --yes           respond yes to all prompts diff --git a/docs/svgs/viv-run-help.svg b/docs/svgs/viv-run-help.svg index 2abca47..f14c3ae 100644 --- a/docs/svgs/viv-run-help.svg +++ b/docs/svgs/viv-run-help.svg @@ -1,4 +1,4 @@ - + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + - viv run --help + viv run --help - + - - usage: viv run [-h] [-s <path>] [-r <path>] [-k] [-b <bin>] [reqs ...] - -run an app/script with an on-demand venv - -examples: -  viv r pycowsay -- "viv isn't venv\!" -  viv r rich -b python -- -m rich -  viv r -s <remote python script> - -positional arguments: -reqs                         requirements specifiers - -options: --h, --help                   show this help message and exit --s, --script <path>          remote script to run --r, --requirements <path>    path/to/requirements.txt file --k, --keep                   preserve environment --b, --bin <bin>              console_script/script to invoke + + usage: viv run [-h] [-s <path/url>] [-r <path>] [-k] [-b <bin>] [reqs  +...] + +run an app/script with an on-demand venv + +examples: +  viv r pycowsay -- "viv isn't venv\!" +  viv r rich -b python -- -m rich +  viv r -s <remote python script> + +positional arguments: +reqs                         requirements specifiers + +options: +-h, --help                   show this help message and exit +-s, --script <path/url>      script to execute +-r, --requirements <path>    path/to/requirements.txt file +-k, --keep                   preserve environment +-b, --bin <bin>              console_script/script to invoke