Skip to content

Commit

Permalink
doc and comments tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Esgrove committed Oct 26, 2024
1 parent df0599c commit d5039f5
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 4 deletions.
2 changes: 2 additions & 0 deletions python-pyo3/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ fn vault_error_to_anyhow(err: VaultError) -> anyhow::Error {
err.into()
}

// These signatures can be removed in a future version since these are all required arguments
// https://github.com/PyO3/pyo3/blob/main/guide/src/function/signature.md#trailing-optional-arguments
#[pyfunction(signature = (vault_stack=None, region=None, bucket=None, key=None, prefix=None))]
fn all(
vault_stack: Option<String>,
Expand Down
2 changes: 1 addition & 1 deletion python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Or install inside venv with:
# With uv
uv pip install .
# Normal venv
python -m pip install -e .
python -m pip install .
```

After installing, you will have `vault` available in path.
Expand Down
5 changes: 3 additions & 2 deletions python/n_vault/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ def main():
action.add_argument(
"--version",
action="store_true",
help="Print vault version",
help="Print vault version and exit",
)
action.add_argument(
"-s",
"--store",
help="Name of element to store. Optionally read from file name",
help="Key name to use for stored value. Optionally read from file name",
nargs="?",
default="",
)
Expand Down Expand Up @@ -157,6 +157,7 @@ def main():
if args.version:
print(VERSION)
exit(0)

try:
if args.store and not (args.value or args.file):
parser.error("--store requires --value or --file")
Expand Down
2 changes: 1 addition & 1 deletion python/uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d5039f5

Please sign in to comment.