Merge pull request #1080 from gboeing/docs

update docs to refer to server usage limitations

README.md

@@ -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.

docs/source/getting-started.rst

@@ -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
 ^^^^^^^^^^^^^^^^^^^^^^
@@ -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
@@ -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

docs/source/index.rst

@@ -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
 

osmnx/features.py

@@ -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

osmnx/graph.py

@@ -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