Skip to content

feat: add NumPy 2.x support, modernize deps, drop EOL Python (fixes #334) #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cl445 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add NumPy 2.x support, modernize deps, drop EOL Python (fixes #334) #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Once you implement and test your feature or bug fix, please submit a Pull Reques
# Setup

1. Clone this repository `git clone [email protected]:tryolabs/norfair.git`.
2. Set up Python. Although version 3.6 is still supported, we recommend using a newer version for development. Using [pyenv](https://github.com/pyenv/pyenv) is highly recommended.
2. Set up Python 3.10+ (we test on 3.10, 3.11, 3.12, 3.13). Using [pyenv](https://github.com/pyenv/pyenv) is highly recommended.
3. Install [poetry](https://python-poetry.org/docs/#installation) version 1.2 or above.
4. Install dependencies `poetry install --all-extras`.

Expand All @@ -33,15 +33,15 @@ Alternatively, make sure to run `poetry run black .` and `poetry run isort .` on

The tests are automatically checked on each PR by a GitHub Action. For this reason, you are encouraged to skip this setup and send a PR without testing it locally first. Delaying this step until the tests fail on the GitHub Action if they ever do.

Tests are run with tox using `poetry run tox`
Tests are run with tox using `poetry run tox`.

You will likely receive an error where tox is not able to find the python versions necessary, to solve this with pyenv:

1. List installed versions with `pyenv versions`.
2. Make sure you have at least one version installed for each python `3.6`, `3.7`, `3.8`, and `3.9`. Available versions can be found with `pyenv install --list` and installed with `pyenv install X.X.X`.
3. Once you have one version of each python run `pyenv local 3.6.X 3.7.X 3.8.X 3.9.X`. Substitute `X` with the specific versions listed in `pyenv versions`.
2. Make sure you have at least one version installed for each Python `3.10`, `3.11`, `3.12`, and `3.13`. Available versions can be found with `pyenv install --list` and installed with `pyenv install X.X.X`.
3. Once you have one version of each Python run `pyenv local 3.10.X 3.11.X 3.12.X 3.13.X`. Substitute `X` with the specific versions listed in `pyenv versions`.

Tox will run the unit tests on all python versions and one integration test that checks the performance in the MOT Challenge. This integration test can take a few minutes and needs an internet connection.
Tox will run the unit tests on all supported Python versions and one integration test that checks the performance in the MOT Challenge. This integration test can take a few minutes and needs an internet connection. The MOT metrics environment pins NumPy < 2 automatically to remain compatible with `motmetrics`.

## Documentation

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Norfair is built, used and maintained by [Tryolabs](https://tryolabs.com).

## Installation

Norfair currently supports Python 3.8+. The latest tested version to support Python 3.7 is [Norfair 2.2.0](https://github.com/tryolabs/norfair/releases/tag/v2.2.0). Later versions may work, but no specific support is planned.
Norfair currently supports Python 3.10+.

For the minimal version, install as:

Expand Down
Loading