Skip to content

Commit d5e321e

Browse files
committed
docs: Update README
1 parent 6e983f5 commit d5e321e

File tree

1 file changed

+6
-14
lines changed

1 file changed

+6
-14
lines changed

README.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66
# polarion-rest-api-client
77

88
<!-- prettier-ignore -->
9-
![image](https://github.com/dbinfrago/polarion-rest-api-client/actions/workflows/build-test-publish.yml/badge.svg)
10-
![image](https://github.com/dbinfrago/polarion-rest-api-client/actions/workflows/lint.yml/badge.svg)
9+
![image](https://github.com/DSD-DBS/polarion-rest-api-client/actions/workflows/build-test-publish.yml/badge.svg)
1110

1211
A client library for accessing Polarion REST API. This project consists of multiple layers. There is a high level, still incomplete
1312
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:
123122
# Documentation
124123

125124
<!-- 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/).
127126

128127
# Installation
129128

130129
You can install the latest released version directly from [PyPI](https://pypi.org/project/polarion-rest-api-client/).
131130

132131
```zsh
133-
pip install polarion-rest-api-client
132+
uv add polarion-rest-api-client
134133
```
135134

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.
138136

139137
```zsh
140138
git clone https://github.com/dbinfrago/polarion-rest-api-client
141139
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
150142
```
151143

152144
## Updating the auto generated part

0 commit comments

Comments
 (0)