setup for pip release

.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - main
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  publish:
+    name: Publish to PyPI
+    if: |
+      github.event.pull_request.merged && contains(github.event.pull_request.labels.*.name, 'autorelease: tagged')
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/sortbikenet/
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build package
+        run: |
+          python -m pip install build
+          python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

plot.py

@@ -8,7 +8,7 @@
 import networkx as nx
 import shapely
 
-from .utils import get_node_positions
+from sortbikenet.utils import get_node_positions
 
 
 def plot_growth(

pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["setuptools >= 77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sortbikenet"
+version = "0.5.0"
+authors = [
+    { name = "Clement Sebastiao" },
+  { name = "Manuel Knepper" },
+  { name = "Michael Szell" },
+]
+maintainers = [{ name = "Manuel Knepper", email = "manuel.knepper@gmx.net" }]
+license = "AGPL-3.0-or-later"
+readme = "README.md"
+description = "BikeNetKit Python package to sort growth of bicycle networks"
+keywords = ["Bicycle network planning", "Networks", "OpenStreetMap", "Urban Planning", "Urban Mobility"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Natural Language :: English",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "geopandas>=0.14",
+    "osmnx>=1.9.4",
+    "pip",
+    "numpy"
+]
+
+[project.urls]
+Repository = "https://github.com/BikeNetKit/SortBikeNet"
+Issues = "https://github.com/BikeNetKit/SortBikeNet/issues"
+
+[project.optional-dependencies]
+test = ["pytest"]
+doc = ["sphinx", "momepy"]
+
+[tool.ruff.lint.extend-per-file-ignores]
+"__init__.py" = ["F401"]  # "Imported but unused: happens with packages
+
+[tool.setuptools.packages.find]
+exclude = [
+    "examples*",
+    "tests*",
+    "results",
+    "docs*",
+    "data*",
+    "scripts*",
+]
+namespaces = false

readme.md

@@ -0,0 +1,20 @@
+[![PyPI Version](https://img.shields.io/pypi/v/sortbikenet?color=10d249)](https://pypi.org/project/SortBikeNet/)
+
+The Python package `sortbikenet` is in the planning phase and  not yet being developed.
+
+## Installation
+
+```
+pip install sortbikenet
+```
+
+## Usage
+In development.
+
+## Docs
+In development.
+
+## Supported by
+Development of BikeNetKit/SortBikeNet is supported by the [Innovation Fund Denmark](https://innovationsfonden.dk/en) and the EU HORIZON project [JUST STREETS](https://www.just-streets.eu).
+
+[![Innovation Fund Denmark](https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_innovationfund.png)](https://innovationsfonden.dk/en)    [![European Union](https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_eu.png)](https://commission.europa.eu/index_en)   [![JUST STREETS](https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_juststreets.png)](https://www.just-streets.eu/) 

setup.py

@@ -0,0 +1,5 @@
+from setuptools import find_packages, setup
+setup(
+    name="sortbikenet",
+    packages=find_packages(),
+)

sortbikenet/__init__.py

@@ -0,0 +1,12 @@
+import contextlib
+from importlib.metadata import PackageNotFoundError, version
+
+#from . import config
+#from . import functions
+from sortbikenet.sortbikenet import sortbikenet
+
+__author__ = "MS, MK"
+__author_email__ = "email@domain.com"
+
+with contextlib.suppress(PackageNotFoundError):
+    __version__ = version("sortbikenet")

sortbikenet/_version.py

@@ -0,0 +1,3 @@
+"""sortbikenet package version."""
+
+__version__ = "0.5.0"  # x-release-please-version

growth.py → sortbikenet/growth.py

@@ -7,7 +7,7 @@
 import networkx as nx
 import momepy as mp
 import shapely
-from .metrics import directness
+from metrics import directness
 
 
 class Orderbike:

metrics.py → sortbikenet/metrics.py

@@ -8,7 +8,7 @@
 import igraph as ig
 import scipy
 from haversine import haversine
-from .utils import get_node_positions
+from utils import get_node_positions
 
 
 def coverage(G, buff_size):

sortbikenet/sortbikenet.py

@@ -0,0 +1,3 @@
+def sortbikenet():
+    'Placeholder for sortbikenet function'
+    print("sortbikenet")