From e12554c9140e831a0e689af401f35f938d17f2bc Mon Sep 17 00:00:00 2001 From: Haoyu <80379456+Haoyu-Gao@users.noreply.github.com> Date: Wed, 20 Nov 2024 13:51:58 +1100 Subject: [PATCH 1/3] Update README.md --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 55 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index ce6f401e..5c8ddce2 100644 --- a/README.md +++ b/README.md @@ -17,44 +17,84 @@ [pyvespa site / documentation](https://pyvespa.readthedocs.io/en/latest/index.html) +## Overview + [Vespa](https://vespa.ai/) is the scalable open-sourced serving engine that enables users to store, compute and rank big data at user serving time. -`pyvespa` provides a python API to Vespa. +`pyvespa` provides a Python API to Vespa. It allows users to create, modify, deploy and interact with running Vespa instances. The main goal of the library is to allow for faster prototyping and get familiar with Vespa features. -## vespacli +## Prerequisites -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). +This project is built based on Python. Make sure you have the following installed before proceeding: -## License +- Python (recommended version: 3.7 or later) +- [Vespa CLI](https://docs.vespa.ai/en/vespa-cli) + +## Installation Steps -Code licensed under the Apache 2.0 license. See [LICENSE](LICENSE) for terms. +### Using Package Manager + +Install directly from PyPI: + +```bash +pip install pyvespa +``` + +### Verification + +To verify the successful installation, run the following command: + +```python +python -m pip show pyvespa +``` -## Development environment +## Development Environment -To install editable version of the library with dev dependencies, run the following command from the root directory of the repository: +To install an editable version of the library with development dependencies, run the following command from the root directory of the repository: ```python pip install -e ".[dev]" ``` -Note that this will enforce linting and formatting with [Ruff](https://github.com/astral-sh/ruff), which also will be triggered by a [pre-commit](https://pre-commit.com/)-hook. +Note that this will enforce linting and formatting with [Ruff](https://github.com/astral-sh/ruff), which will also be triggered by a [pre-commit](https://pre-commit.com/) hook. -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. +This means you may encounter 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 them manually with the `ruff` CLI tool. ## Releases Find releases and release notes on [GitHub](https://github.com/vespa-engine/pyvespa/releases). -### Release details +### Release Details -The release flow is semi-automated, but involves a few manual steps. +The release flow is semi-automated but involves a few manual steps: 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. +2. 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. Merge this PR to keep the repository's version updated. This workflow can also be dispatched manually, but note that steps 3 and 4 will ONLY be triggered by a release. + +## License + +Code is licensed under the Apache 2.0 license. See [LICENSE](LICENSE) for terms. + +## External Documents + +For more details, refer to additional documents: + +- [Documentation](https://pyvespa.readthedocs.io/en/latest/index.html) +- [Vespa CLI README](https://github.com/vespa-engine/pyvespa/tree/master/vespacli) + +## Version History + +For version history, refer to the [GitHub Releases](https://github.com/vespa-engine/pyvespa/releases). + +## Help and Support + +For FAQs, commonly encountered errors, or further assistance, please refer to: + +- [Pyvespa Documentation](https://pyvespa.readthedocs.io/en/latest/index.html) +- Report issues on the [GitHub Issues Page](https://github.com/vespa-engine/pyvespa/issues). From 135a4f39c94df9de14c783186aedec40ac24283b Mon Sep 17 00:00:00 2001 From: Haoyu <80379456+Haoyu-Gao@users.noreply.github.com> Date: Thu, 21 Nov 2024 23:55:37 +1100 Subject: [PATCH 2/3] Update README.md with manual check --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5c8ddce2..56cb1faa 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,7 @@ The main goal of the library is to allow for faster prototyping and get familiar ## Prerequisites -This project is built based on Python. Make sure you have the following installed before proceeding: - -- Python (recommended version: 3.7 or later) -- [Vespa CLI](https://docs.vespa.ai/en/vespa-cli) +This project is built based on Python. Make sure you have installed Python before proceeding: ## Installation Steps @@ -81,6 +78,11 @@ This workflow can also be dispatched manually, but note that steps 3 and 4 will Code is licensed under the Apache 2.0 license. See [LICENSE](LICENSE) for terms. +## 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). + ## External Documents For more details, refer to additional documents: From 27c9174eeebb5ba22718f63138afd1fdd538162f Mon Sep 17 00:00:00 2001 From: Haoyu <80379456+Haoyu-Gao@users.noreply.github.com> Date: Fri, 22 Nov 2024 11:07:47 +1100 Subject: [PATCH 3/3] Drop the obvious prerequisites, which is not that useful --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 56cb1faa..4c744123 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,6 @@ compute and rank big data at user serving time. It allows users to create, modify, deploy and interact with running Vespa instances. The main goal of the library is to allow for faster prototyping and get familiar with Vespa features. -## Prerequisites - -This project is built based on Python. Make sure you have installed Python before proceeding: - ## Installation Steps ### Using Package Manager @@ -47,6 +43,9 @@ To verify the successful installation, run the following command: python -m pip show pyvespa ``` +### Additional Information +Please refer to the [official document](https://pyvespa.readthedocs.io/en/stable/) for more installation details. + ## Development Environment To install an editable version of the library with development dependencies, run the following command from the root directory of the repository: