diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index d0b99e7..6ddd396 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -55,7 +55,7 @@ jobs: os: [ ubuntu-latest ] submodule: - { name: "fixbikenet", pytest_args: "tests/test_fixbikenet.py" } - - { name: "functions", pytest_args: "tests/test_functions.py" } + - { name: "utils", pytest_args: "tests/test_utils.py" } fail-fast: false name: ${{ matrix.submodule.name }} (${{ matrix.python-version }} on ${{ matrix.os }}) diff --git a/docs/source/reference_developer.rst b/docs/source/reference_developer.rst index e13a4d9..67c5f28 100644 --- a/docs/source/reference_developer.rst +++ b/docs/source/reference_developer.rst @@ -5,25 +5,25 @@ This is the complete developer reference for the FixBikeNet package. If you are fixbikenet.fixbikenet ------------------------ +--------------------- .. automodule:: fixbikenet.fixbikenet :members: -fixbikenet.functions ---------------------- +fixbikenet.osm +-------------- -.. automodule:: fixbikenet.functions +.. automodule:: fixbikenet.osm :members: - :private-members: -fixbikenet.osm --------------- +fixbikenet.utils +---------------- -.. automodule:: fixbikenet.osm +.. automodule:: fixbikenet.utils :members: + :private-members: fixbikenet.settings diff --git a/docs/source/reference_user.rst b/docs/source/reference_user.rst index 93f2499..a134f49 100644 --- a/docs/source/reference_user.rst +++ b/docs/source/reference_user.rst @@ -11,7 +11,6 @@ fixbikenet.fixbikenet .. automodule:: fixbikenet.fixbikenet :members: - :no-index: fixbikenet.settings @@ -19,12 +18,10 @@ fixbikenet.settings .. automodule:: fixbikenet.settings :members: - :no-index: fixbikenet.osm -------------- .. automodule:: fixbikenet.osm - :members: - :no-index: \ No newline at end of file + :members: \ No newline at end of file diff --git a/environment-dev.yml b/environment-dev.yml index bbf7444..9d045d7 100644 --- a/environment-dev.yml +++ b/environment-dev.yml @@ -5,8 +5,9 @@ dependencies: - python>=3.12 - osmnx>=2 - tqdm + - bikenetlib - # additional to the non-dev env + # Additional to the non-dev env - ipykernel - ipywidgets - pytest @@ -20,8 +21,8 @@ dependencies: - jupyterlab - matplotlib - pip: - # not available via conda-forge: + # Not available via conda-forge: - sphinx-copybutton - sphinxext-opengraph - furo - - fixbikenet \ No newline at end of file + - fixbikenet # For docs, get latest version fast from pypi \ No newline at end of file diff --git a/environment.yml b/environment.yml index ab2aba2..d7ba93c 100644 --- a/environment.yml +++ b/environment.yml @@ -4,4 +4,5 @@ channels: dependencies: - python>=3.12 - osmnx>=2 - - tqdm \ No newline at end of file + - tqdm + - bikenetlib \ No newline at end of file diff --git a/fixbikenet/__init__.py b/fixbikenet/__init__.py index 8b314ba..fe646e5 100644 --- a/fixbikenet/__init__.py +++ b/fixbikenet/__init__.py @@ -14,7 +14,7 @@ from . import constants from . import osm from . import settings -from . import functions +from . import utils __author__ = "FixBikeNet contributors" __author_email__ = "michael@szell.net" diff --git a/fixbikenet/fixbikenet.py b/fixbikenet/fixbikenet.py index 86f8c9e..eb9a658 100644 --- a/fixbikenet/fixbikenet.py +++ b/fixbikenet/fixbikenet.py @@ -15,7 +15,7 @@ import matplotlib.pyplot as plt -from fixbikenet.functions import ( +from fixbikenet.utils import ( _get_weighted_distances, _import_data_files, _print_footer, diff --git a/fixbikenet/functions.py b/fixbikenet/utils.py similarity index 99% rename from fixbikenet/functions.py rename to fixbikenet/utils.py index 039d2d3..4d414dd 100644 --- a/fixbikenet/functions.py +++ b/fixbikenet/utils.py @@ -1,4 +1,4 @@ -"""Utility functions for `fixbikenet`.""" +"""Utility utils for `fixbikenet`.""" import itertools import os diff --git a/pyproject.toml b/pyproject.toml index 5be0861..96930f4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,6 +39,7 @@ dependencies = [ "osmnx>=2", "geojson", "tqdm", + "bikenetlib", ] [project.urls] diff --git a/tests/test_functions.py b/tests/test_utils.py similarity index 99% rename from tests/test_functions.py rename to tests/test_utils.py index 8100a49..76cd5bc 100644 --- a/tests/test_functions.py +++ b/tests/test_utils.py @@ -4,7 +4,7 @@ from shapely.geometry import Point import fixbikenet as fbn -from fixbikenet.functions import * +from fixbikenet.utils import * fbn.constants._ROUTING_PENALTY = {0: 5, 1: 1} fbn.constants._BETWEENNESS_RANDOM_NODES = 300