Optimally, when contributing to this repository, please first discuss the change you wish to make via an issue, email, or any other method with the owners of this repository before making a change.
This examples repository is meant to be a collection of curated examples for how to request and use the ohsome-api effectively. The individual examples should be well documented, easy to follow and be composed of reusable building-blocks. Ideally, every example should be self-contained and not repeat concepts which are already shown in another example. The focus is more on showcasing the technical concepts and usage patterns rather than on the data analysis side of things (although it is of course best when it is possible to combine all of this).
The project's readme also includes a list of examples where the ohsome API is used in real world applications and data analyses. Free free to propose to have your project added to the list.
All changes to this repository should go through pull requests, and require:
- Ensure that changes are working and don't break other examples (e.g. after updating dependencies).
- Update the
README.mds when adding new examples. - If an example requires external libraries: Ensure that these are properly documented and included in the requirements definitions file (e.g.
requirements.txtfor Python examples). - Check your code style (e.g. using PEP 8 for Python examples)