Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amrit110 authored Jan 29, 2025
1 parent cb81da1 commit 0771b56
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,30 +58,31 @@ df = table.run()

## 🧑🏿‍💻 Developing

### Using poetry
### Using uv

The development environment can be set up using
[poetry](https://python-poetry.org/docs/#installation). Hence, make sure it is
[uv](https://docs.astral.sh/uv/). Hence, make sure it is
installed and then run:


```bash
python3 -m poetry install
source $(poetry env info --path)/bin/activate
uv sync
source .venv/bin/activate
```

In order to install dependencies for testing (codestyle, unit tests, integration tests),
run:

```bash
python3 -m poetry install --with test
uv sync --dev
source .venv/bin/activate
```

API documentation is built using [Sphinx](https://www.sphinx-doc.org/en/master/) and
can be locally built by:

```bash
python3 -m poetry install --with docs
uv sync --group docs
cd docs
make html SPHINXOPTS="-D nbsphinx_allow_errors=True"
```
Expand Down

0 comments on commit 0771b56

Please sign in to comment.