Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasht86 committed May 29, 2024
1 parent 13ef9a1 commit b8cc35a
Showing 1 changed file with 11 additions and 23 deletions.
34 changes: 11 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,14 @@ The main goal of the library is to allow for faster prototyping and get familiar
## vespacli

This repo also contains the python wrapper for the [Vespa CLI](https://docs.vespa.ai/en/vespa-cli).
See [README](https://github.com/vespa-engine/pyvespa/tree/master/vespacli) and [Veso]
See [README](https://github.com/vespa-engine/pyvespa/tree/master/vespacli).

## License
Code licensed under the Apache 2.0 license. See [LICENSE](LICENSE) for terms.

Code licensed under the Apache 2.0 license. See [LICENSE](LICENSE) for terms.

## Development environment

To install editable version of the library with dev dependencies, run the following command from the root directory of the repository:

```python
Expand All @@ -40,29 +41,16 @@ Note that this will enforce linting and formatting with [Ruff](https://github.co
This means that you may get an error message when trying to commit changes if the code does not pass the linting and formatting checks. The errors are detailed in the output, and you can optionally run manually with `ruff` CLI-tool.

## Releases
Find releases and release notes on [GitHub](https://github.com/vespa-engine/pyvespa/releases).


### Release instructions
* Check out master branch
* Temporarily change library version number in `get_target_version()` in [setup.py](setup.py) to the new version,
e.g. "0.16.0".
* Run from the pyvespa root directory to create the library files:

```
python3 -m pip install --upgrade pip
python3 -m pip install twine wheel
Find releases and release notes on [GitHub](https://github.com/vespa-engine/pyvespa/releases).

python3 setup.py sdist bdist_wheel
```
### Release details

With write access to [pypi.org/project/pyvespa/](https://pypi.org/project/pyvespa/),
upload, this requires username "__token__" and the token value as password, including the pypi- prefix:
The release flow is semi-automated, but involves a few manual steps.

```
python3 -m twine upload dist/*
```
1. Create a new release from [github.com/vespa-engine/pyvespa/releases/new](https://github.com/vespa-engine/pyvespa/releases/new).
2. Make sure to tag the release with the version number, e.g., `v0.41.0`.
3. This tag will trigger a github action that will publish the package to [PyPI](https://pypi.org/project/pyvespa/).
4. A PR will also be automatically created to update the affected files with the new version. This PR should be merged to keep the version updated in the repository.

At this point, the package has been released.
Create a new release tag at [github.com/vespa-engine/pyvespa/releases/new](https://github.com/vespa-engine/pyvespa/releases/new)
with a summary of the code changes.
This workflow can also be dispatched manually, but note that steps 3 and 4 will ONLY be triggered by a release.

0 comments on commit b8cc35a

Please sign in to comment.