Skip to content
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.

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

update docs to refer to server usage limitations #1080

Merged
merged 1 commit into from
Oct 29, 2023
Merged
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ If you have any trouble, consult the [User Reference](https://osmnx.readthedocs.

## License

OSMnx is open source and licensed under the MIT license. OpenStreetMap's open data [license](https://www.openstreetmap.org/copyright/) requires that derivative works provide proper attribution.
OSMnx is open source and licensed under the MIT license. OpenStreetMap's open data [license](https://www.openstreetmap.org/copyright/) requires that derivative works provide proper attribution. Refer to the [Getting Started](https://osmnx.readthedocs.io/en/stable/getting-started.html) guide for usage limitations.
6 changes: 5 additions & 1 deletion docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The `OSMnx Examples`_ gallery contains tutorials and demonstrations of all these
Configuration
^^^^^^^^^^^^^

You can configure OSMnx using the :code:`settings` module. Here you can adjust logging behavior, caching, server endpoints, and more. You can also configure OSMnx to retrieve historical snapshots of OpenStreetMap data as of a certain date.
You can configure OSMnx using the :code:`settings` module. Here you can adjust logging behavior, caching, server endpoints, and more. You can also configure OSMnx to retrieve historical snapshots of OpenStreetMap data as of a certain date. Refer to the FAQ below for server usage limitations.

Geocoding and Querying
^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -130,6 +130,8 @@ Frequently Asked Questions

*I have a usage question.* Please ask it on `StackOverflow`_.

*Are there any usage limitations?* Yes. Refer to the `Nominatim Usage Policy`_ and `Overpass Commons`_ documentation for usage limitations and restrictions that you must adhere to at all times. If you use an alternative Nominatim/Overpass instance, ensure you understand and obey their usage policies. If you need to exceed these limitations, consider installing your own hosted instance and setting OSMnx to use it.

.. _OSMnx Examples: https://github.com/gboeing/osmnx-examples
.. _GeoPandas: https://geopandas.org
.. _NetworkX: https://networkx.org
Expand All @@ -150,3 +152,5 @@ Frequently Asked Questions
.. _Changelog: https://github.com/gboeing/osmnx/blob/main/CHANGELOG.md
.. _projects: https://geoffboeing.com/2018/03/osmnx-features-roundup
.. _StackOverflow: https://stackoverflow.com/search?q=osmnx
.. _Nominatim Usage Policy: https://operations.osmfoundation.org/policies/nominatim/
.. _Overpass Commons: https://dev.overpass-api.de/overpass-doc/en/preface/commons.html
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ If you have any trouble, consult the :doc:`user-reference`. The OSMnx repository
License
-------

OSMnx is open source and licensed under the MIT license. OpenStreetMap's open data `license`_ requires that derivative works provide proper attribution.
OSMnx is open source and licensed under the MIT license. OpenStreetMap's open data `license`_ requires that derivative works provide proper attribution. Refer to the :doc:`getting-started` guide for usage limitations.

.. _license: https://www.openstreetmap.org/copyright

Expand Down
2 changes: 2 additions & 0 deletions osmnx/features.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

For more details, see https://wiki.openstreetmap.org/wiki/Map_features and
https://wiki.openstreetmap.org/wiki/Elements

Refer to the Getting Started guide for usage limitations.
"""

import logging as lg
Expand Down
9 changes: 8 additions & 1 deletion osmnx/graph.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
"""Download and create graphs from OpenStreetMap data."""
"""
Download and create graphs from OpenStreetMap data.

This module uses filters to query the Overpass API: you can either specify a
built-in network type or provide your own custom filter with Overpass QL.

Refer to the Getting Started guide for usage limitations.
"""

import itertools
from warnings import warn
Expand Down