Chore/refactor functions into utils procedure

.github/workflows/test.yml

@@ -31,7 +31,7 @@ jobs:
       run:
         shell: bash -elo pipefail {0}
 
-    name: Cache for ${{ matrix.python-version }} on ${{ matrix.os }}
+    name: cache (${{ matrix.python-version }} on ${{ matrix.os }})
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v7
@@ -55,7 +55,7 @@ jobs:
         os: [ubuntu-latest]
         submodule:
           - { name: "growbikenet", pytest_args: "tests/test_growbikenet.py" }
-          - { name: "functions", pytest_args: "tests/test_functions.py" }
+          - { name: "utils", pytest_args: "tests/test_utils.py" }
           - { name: "visualization", pytest_args: "tests/test_visualization.py --mpl" }
       fail-fast: false
 

docs/source/reference_developer.rst

@@ -16,10 +16,17 @@ growbikenet.constants
    :members:
    :private-members:
 
-growbikenet.functions
----------------------
+growbikenet.osm
+---------------
+
+.. automodule:: growbikenet.osm
+   :members:
+   :private-members:
+
+growbikenet.utils
+-----------------
 
-.. automodule:: growbikenet.functions
+.. automodule:: growbikenet.utils
    :members:
    :private-members:
 
@@ -34,5 +41,12 @@ growbikenet.visualization
 -------------------------
 
 .. automodule:: growbikenet.visualization
+   :members:
+   :private-members:
+
+growbikenet._procedure
+----------------------
+
+.. automodule:: growbikenet._procedure
    :members:
    :private-members:

docs/source/reference_user.rst

@@ -12,6 +12,13 @@ growbikenet.growbikenet
    :members:
    :no-index:
 
+growbikenet.osm
+---------------
+
+.. automodule:: growbikenet.osm
+   :members:
+   :no-index:
+
 growbikenet.settings
 --------------------
 

examples/batchexport_onecity.py

@@ -41,7 +41,7 @@
 
 import growbikenet as gbn
 from growbikenet import settings
-from growbikenet.functions import slugify
+from growbikenet.utils import slugify
 
 city_query = "Barcelona"
 city_id = "barcelona_es"

growbikenet/__init__.py

@@ -1,11 +1,24 @@
+"""
+GrowBikeNet is a Python package to grow an urban bicycle network from scratch 
+or from an existing bicycle network.
+
+Full documentation at: https://docs.bikenetkit.org/GrowBikeNet/
+
+If you use GrowBikeNet, please cite: https://doi.org/10.1038/s41598-022-10783-y
+"""
+
 import contextlib
 from importlib.metadata import PackageNotFoundError, version
 
 from growbikenet.growbikenet import growbikenet
+from . import constants
+from . import growbikenet
+from . import osm
+from . import settings
+from . import utils
+from . import visualization
 
-from . import functions, visualization
-
-__author__ = "Michael Szell, Manuel Knepper, Anastassia Vybornova"
+__author__ = "GrowBikeNet contributors"
 __author_email__ = "michael@szell.net"
 
 with contextlib.suppress(PackageNotFoundError):