Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (35 loc) · 990 Bytes

CONTRIBUTING.md

File metadata and controls

45 lines (35 loc) · 990 Bytes

Contributing

If you notice an error, please don't hesitate to open an issue.

Development setup

# update
sudo apt update
# install Python 3.11 for ensuring that tests can be run
sudo apt install python3-pip \
  python3.11 python3.11-dev python3.11-distutils python3.11-venv

# check out repo
git clone https://github.com/birdnet-team/birdnet.git
cd birdnet
# create virtual environment
python3.11 -m venv .venv311
source .venv311/bin/activate
python3.11 -m pip install uv
python3.11 -m uv pip install -e .[tests,dev,and-cuda,litert]

Running the tests

# first install the tool like in "Development setup"
# then, navigate into the directory of the repo (if not already done)
cd birdnet
# activate environment
source .venv311/bin/activate
# run tests
tox

Final lines of test result output:

  py311: commands succeeded
  congratulations :)

Notes

  • Python 3.10 is not supported because of missing typing features -> from typing import Self