Skip to content

Commit

Permalink
docs: Add hatch usage guide
Browse files Browse the repository at this point in the history
  • Loading branch information
paveldedik committed Sep 13, 2024
1 parent b1e6f30 commit dd7c298
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,16 @@ pre-commit install --install-hooks

If you're adding new features or fixing bugs, please include tests that cover your changes. Run `pytest` to execute the test suite.

You need to install test dependencies to be able to run pytest:
You need to install test dependencies to be able to run `pytest`:

```bash
python -m pip install -e ".[test]"
python -m pip install -e ".[full,test]"
```

You can also use `hatch` which automatically creates virtual environment with all the optional dependencies:

```bash
hatch shell
```

### Documentation Updates
Expand Down
6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ test = [
"httpx",
]

[tool.hatch.envs.default]
python = "3.12"
platforms = ["linux", "macos"]
description = "Default environment with Python 3.12 for maximum compatibility"
features = ["dev", "full", "django", "test"]

[tool.hatch.version]
source = "vcs"

Expand Down

0 comments on commit dd7c298

Please sign in to comment.