Skip to content

Commit

Permalink
update readme for old python version and prevent release script run
Browse files Browse the repository at this point in the history
  • Loading branch information
Esgrove committed Nov 11, 2024
1 parent 95710ab commit 0466f02
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 11 deletions.
15 changes: 4 additions & 11 deletions python/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# nitor-vault

> [!CAUTION]
> This implementation has been superceded by the [Python-pyo3](../python-pyo3) version
> that uses the Rust implementation internally.
Python vault implementation.

See the [root readme](../README.md) for more information.
Expand Down Expand Up @@ -59,17 +63,6 @@ python -m pip install .

After installing, you will have `vault` available in path.

## Release

Use the provided shell script.
Note that you need to have a venv with the extra dependencies installed active when running the script.

```shell
./release.sh
# See help
./release.sh -h
```

## Code formatting and linting

Code formatting and linting with [ruff](https://github.com/charliermarsh/ruff).
Expand Down
2 changes: 2 additions & 0 deletions python/release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ init_options() {

init_options "$@"

print_error_and_exit "This implementation has been replaced with the python-pyo3 version"

print_magenta "Updating version number..."
"${SED_COMMAND[@]}" "s/^VERSION = .*/VERSION = \"$NEW_VERSION\"/g" n_vault/__init__.py
"${SED_COMMAND[@]}" "s/^version = .*/version = \"$NEW_VERSION\"/g" pyproject.toml
Expand Down

0 comments on commit 0466f02

Please sign in to comment.