|
6 | 6 | # polarion-rest-api-client |
7 | 7 |
|
8 | 8 | <!-- prettier-ignore --> |
9 | | - |
10 | | - |
| 9 | + |
11 | 10 |
|
12 | 11 | A client library for accessing Polarion REST API. This project consists of multiple layers. There is a high level, still incomplete |
13 | 12 | version of the client and a feature complete low level API client, which was generated using an [OpenAPI generator](https://github.com/openapi-generators/openapi-python-client). |
@@ -123,30 +122,23 @@ Things to know: |
123 | 122 | # Documentation |
124 | 123 |
|
125 | 124 | <!-- prettier-ignore --> |
126 | | -Read the [full documentation on Github pages](https://dbinfrago.github.io/polarion-rest-api-client). |
| 125 | +Read the [full documentation](https://polarion-rest-api-client.readthedocs.io/en/latest/). |
127 | 126 |
|
128 | 127 | # Installation |
129 | 128 |
|
130 | 129 | You can install the latest released version directly from [PyPI](https://pypi.org/project/polarion-rest-api-client/). |
131 | 130 |
|
132 | 131 | ```zsh |
133 | | -pip install polarion-rest-api-client |
| 132 | +uv add polarion-rest-api-client |
134 | 133 | ``` |
135 | 134 |
|
136 | | -To set up a development environment, clone the project and install it into a |
137 | | -virtual environment. |
| 135 | +To set up a development environment, clone the project and install it with uv. |
138 | 136 |
|
139 | 137 | ```zsh |
140 | 138 | git clone https://github.com/dbinfrago/polarion-rest-api-client |
141 | 139 | cd polarion-rest-api-client |
142 | | -python -m venv .venv |
143 | | - |
144 | | -source .venv/bin/activate.sh # for Linux / Mac |
145 | | -.venv\Scripts\activate # for Windows |
146 | | - |
147 | | -pip install -U pip pre-commit |
148 | | -pip install -e '.[docs,test]' |
149 | | -pre-commit install |
| 140 | +uv sync --extra docs --extra test |
| 141 | +uvx pre-commit run --all-files |
150 | 142 | ``` |
151 | 143 |
|
152 | 144 | ## Updating the auto generated part |
|
0 commit comments