diff --git a/python-pyo3/README.md b/python-pyo3/README.md index 093caba0..6398b1a7 100644 --- a/python-pyo3/README.md +++ b/python-pyo3/README.md @@ -6,10 +6,12 @@ See the [root readme](../README.md) for more general information. ## Usage +Uses `pvault` command name to avoid conflict with the previous Python version and the Rust version. + ```console -Usage: vault [OPTIONS] COMMAND [ARGS]... + Usage: pvault [OPTIONS] COMMAND [ARGS]... -Nitor Vault CLI, see https://github.com/nitorcreations/vault for usage examples + Nitor Vault CLI, see https://github.com/nitorcreations/vault for usage examples ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │ --bucket -b TEXT Override the bucket name [env var: VAULT_BUCKET] │ @@ -40,6 +42,23 @@ Nitor Vault CLI, see https://github.com/nitorcreations/vault for usage examples ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ ``` +## Install + +Install command globally using pip. From repo root: + +```shell +cd python-pyo3 +pip install . +``` + +Check the command is found in path. +If you ran the install command inside a virtual env, +it will only be installed to the venv. + +```shell +which -a pvault +``` + ## Development Uses: