Skip to content

Commit

Permalink
Document UV project management
Browse files Browse the repository at this point in the history
  • Loading branch information
davidbenque committed Jan 13, 2025
1 parent 1f4b541 commit 1bc18cd
Showing 1 changed file with 32 additions and 3 deletions.
35 changes: 32 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,36 @@
# CryptPad Documentation
## Installation
Using [Poetry](https://python-poetry.org/docs/)

### UV

To use [UV](https://docs.astral.sh/uv/#getting-started), install dependencies with

```bash
uv sync
```

Activate the environment with

```bash
source ./.venv/bin/activate
```

Keep `requirements.txt` up to date with the UV venv by running

```bash
uv export --format requirements-txt
```

### Poetry

To use [Poetry](https://python-poetry.org/docs/) rename `pyprojet-poetry.toml` to `pyproject.toml` and run
```bash
poetry install
```
Activate the environment with

or Pip
```bash
pip install -r requirements.txt
poetry shell
```

Keep `requirements.txt` up to date with the Poetry environment by running
Expand All @@ -16,6 +39,12 @@ Keep `requirements.txt` up to date with the Poetry environment by running
poetry export -f requirements.txt --output requirements.txt
```

### Pip
```bash
pip install -r requirements.txt
```


## Build
English `en` is the default language.

Expand Down

0 comments on commit 1bc18cd

Please sign in to comment.