Read more about the project's standards in the contributing guidelines and ensure that you have installed the necessary dependencies for the test suite.
Format the code per the project's style by running the pre-commit hooks:
pre-commit install
pre-commit run -aRun the test suite locally by running (from the repository root):
bash ./tests/lint_test.shPull requests trigger continuous integration tests via GitHub Actions (see workflow), including the following steps:
- build the docs
- check code formatting
- lint the code and docstrings
- type check the code
- run tests and coverage
To publish a new version, update CHANGELOG.md and edit the version number in osmnx/_version.py. If necessary, update the dates in LICENSE.txt and docs/source/conf.py and the dependency versions in pyproject.toml. Then tag the repository with its new semantic version, like v1.2.3.
Pushing the tags will trigger Github Actions to publish the distribution to PyPI (see workflow) and publish a new image to Docker Hub (see workflow). The regro-cf-autotick-bot will open a pull request to update the conda-forge feedstock: merge that PR to publish the distribution on conda-forge. Finally, update the Examples Gallery to use the new version.