Skip to content

docs(readme): recommend uv as an alternative to pip #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
martinkersner wants to merge 1 commit into from
Closed

docs(readme): recommend uv as an alternative to pip #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@ This package is compatible with Python v3.10+.
pip install datamaxi
```

Or with [uv](https://docs.astral.sh/uv/):

```shell
uv pip install datamaxi
# or, in a uv-managed project
uv add datamaxi
```

## Configuration

Private API endpoints are protected by an API key.
Expand Down Expand Up @@ -416,11 +424,22 @@ cd datamaxi-python
pip install -r requirements/common.txt
```

Or with [uv](https://docs.astral.sh/uv/):

```shell
git clone https://github.com/bisonai/datamaxi-python.git
cd datamaxi-python
uv venv
uv pip install -r requirements/common.txt
```

## Tests

```shell
# Install test dependencies
pip install -r requirements/requirements-test.txt
# or with uv
uv pip install -r requirements/requirements-test.txt

# Run unit tests (no API key required)
python -m pytest tests/test_api.py -v
Expand Down
Loading