Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 9 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,15 @@ and pip-installing it in editable mode with the required dependencies:
git clone https://github.com/neuroinformatics-unit/ethology.git

# then run from within the repository root folder:
pip install -e .[dev] # works on most shells
pip install -e '.[dev]' # works on zsh (the default shell on macOS)
pip install -e . --group dev
```
This will install all the dependencies needed for development, such as `pytest` and `pre-commit`.
If you also want to [edit the documentation](#editing-the-documentation) and preview the changes locally, you will additionally need the `docs` dependencies.
To install both `dev` and `docs` dependencies at once, use `--all-groups`:

```sh
pip install -e . --all-groups
```
This should install all the dependencies needed for development, such as `pytest` and `pre-commit`. If you also want to edit the documentation and preview the changes locally, you will additionally need the `docs` extra dependencies. See [Editing the documentation](#editing-the-documentation) for more details.

Finally, install the [pre-commit hooks](https://pre-commit.com/):

Expand Down Expand Up @@ -140,8 +145,7 @@ To edit the documentation, first clone the repository, and install `ethology` in

Then, install a few additional dependencies in your development environment to be able to build the documentation locally. To do this, run the following command from the root of the repository:
```sh
pip install -e .[docs] # works on most shells
pip install -e '.[docs]' # works on zsh (default on macOS)
pip install -e --group docs
```

Now create a new branch, edit the documentation source files (`.md` or `.rst` in the `docs` folder),
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ dependencies = [
"User Support" = "https://github.com/neuroinformatics-unit/ethology/issues"


[project.optional-dependencies]
[dependency-groups]
dev = [
"pytest",
"pytest-cov",
Expand Down Expand Up @@ -151,7 +151,7 @@ python =
3.13: py313

[testenv]
extras =
dependency_groups =
dev
commands =
pytest -v --color=yes --cov=ethology --cov-report=xml
Expand Down
Loading