edsger 0.1.0__tar.gz → 0.1.1__tar.gz

{edsger-0.1.0 → edsger-0.1.1}/.github/workflows/publish.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ["3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4

{edsger-0.1.0 → edsger-0.1.1}/.github/workflows/tests.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-22.04, windows-2022, macos-14]
-        python-version: ["3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4
@@ -23,6 +23,12 @@ jobs:
         python -m pip install --upgrade pip
         pip install -r requirements-dev.txt
         pip install .
+    - name: Format Python code with black
+      run: |
+        black --check --diff .
+    - name: Lint Cython code
+      run: |
+        cython-lint src/edsger/commons.pyx src/edsger/dijkstra.pyx src/edsger/path_tracking.pyx src/edsger/pq_4ary_dec_0b.pyx src/edsger/spiess_florian.pyx src/edsger/star.pyx src/edsger/commons.pxd src/edsger/pq_4ary_dec_0b.pxd
     - name: Testing
       run: |
         python -m pytest tests

edsger-0.1.1/.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 24.10.0
+    hooks:
+      - id: black
+        files: '\.(py)$'
+        exclude: 'src/edsger/.*\.pyx$'
+
+  - repo: https://github.com/MarcoGorelli/cython-lint
+    rev: v0.16.2
+    hooks:
+      - id: cython-lint
+        files: '\.(pyx|pxd)$'
+        args: [--max-line-length=88]

edsger-0.1.1/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: edsger
+Version: 0.1.1
+Summary: Graph algorithms in Cython.
+Author-email: François Pacull <francois.pacull@architecture-performance.fr>
+Maintainer-email: François Pacull <francois.pacull@architecture-performance.fr>
+License: MIT License
+Project-URL: Repository, https://github.com/aetperf/Edsger
+Project-URL: Documentation, https://edsger.readthedocs.io
+Keywords: python,graph,shortest path,Dijkstra
+Platform: any
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: setuptools
+Requires-Dist: setuptools_scm
+Requires-Dist: numpy>=1.26
+Requires-Dist: Cython>=3
+Requires-Dist: pandas
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: scipy<1.11; extra == "test"
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: sphinx_design; extra == "doc"
+Requires-Dist: sphinx_rtd_theme; extra == "doc"
+Dynamic: license-file
+
+
+![Tests Status](https://github.com/aetperf/edsger/actions/workflows/tests.yml/badge.svg?branch=release)
+[![PyPI version](https://img.shields.io/pypi/v/edsger.svg)](https://pypi.org/project/edsger/)
+[![Downloads](https://static.pepy.tech/badge/edsger)](https://pepy.tech/project/edsger)
+[![Python 3.9 | 3.10 | 3.11 | 3.12 | 3.13](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://pypi.org/project/edsger/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Cython lint: cython-lint](https://img.shields.io/badge/cython--lint-enabled-brightgreen.svg)](https://github.com/MarcoGorelli/cython-lint)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# Edsger
+
+*Graph algorithms in Cython*
+
+Welcome to our Python library for graph algorithms. So far, the library only includes Dijkstra's algorithm but we should add a range of common path algorithms later. It is also open-source and easy to integrate with other Python libraries. To get started, simply install the library using pip, and import it into your Python project.
+
+Documentation : [https://edsger.readthedocs.io/en/latest/](https://edsger.readthedocs.io/en/latest/)
+
+## Contributing
+
+We welcome contributions to the Edsger library. If you have any suggestions, bug reports, or feature requests, please open an issue on our [GitHub repository](https://github.com/aetperf/Edsger).
+
+## License
+
+Edsger is licensed under the MIT License. See the LICENSE file for more details.
+
+## Contact
+
+For any questions or inquiries, please contact François Pacull at [francois.pacull@architecture-performance.fr](mailto:francois.pacull@architecture-performance.fr).

edsger-0.1.1/README.md

@@ -0,0 +1,28 @@
+
+![Tests Status](https://github.com/aetperf/edsger/actions/workflows/tests.yml/badge.svg?branch=release)
+[![PyPI version](https://img.shields.io/pypi/v/edsger.svg)](https://pypi.org/project/edsger/)
+[![Downloads](https://static.pepy.tech/badge/edsger)](https://pepy.tech/project/edsger)
+[![Python 3.9 | 3.10 | 3.11 | 3.12 | 3.13](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://pypi.org/project/edsger/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Cython lint: cython-lint](https://img.shields.io/badge/cython--lint-enabled-brightgreen.svg)](https://github.com/MarcoGorelli/cython-lint)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# Edsger
+
+*Graph algorithms in Cython*
+
+Welcome to our Python library for graph algorithms. So far, the library only includes Dijkstra's algorithm but we should add a range of common path algorithms later. It is also open-source and easy to integrate with other Python libraries. To get started, simply install the library using pip, and import it into your Python project.
+
+Documentation : [https://edsger.readthedocs.io/en/latest/](https://edsger.readthedocs.io/en/latest/)
+
+## Contributing
+
+We welcome contributions to the Edsger library. If you have any suggestions, bug reports, or feature requests, please open an issue on our [GitHub repository](https://github.com/aetperf/Edsger).
+
+## License
+
+Edsger is licensed under the MIT License. See the LICENSE file for more details.
+
+## Contact
+
+For any questions or inquiries, please contact François Pacull at [francois.pacull@architecture-performance.fr](mailto:francois.pacull@architecture-performance.fr).

{edsger-0.1.0 → edsger-0.1.1}/docs/source/api.md

@@ -114,23 +114,3 @@ paths = dijkstra.run(
     heap_length_ratio=0.5
 )
 ```
-
-### Graph Data Format
-
-Edsger expects graph data as a pandas DataFrame with the following structure:
-
-| Column | Type    | Description                          |
-|--------|---------|--------------------------------------|
-| tail   | int     | Source vertex ID                     |
-| head   | int     | Destination vertex ID                |
-| weight | float   | Edge weight (must be non-negative)   |
-
-Example:
-```python
-edges = pd.DataFrame({
-    'tail': [0, 0, 1, 2],
-    'head': [1, 2, 2, 3],
-    'weight': [1.0, 4.0, 2.0, 1.0]
-})
-```
-

{edsger-0.1.0 → edsger-0.1.1}/docs/source/conf.py

@@ -18,12 +18,13 @@ sys.path.insert(0, os.path.abspath("../../src/"))
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "Edsger"
-copyright = "2024, Architecture & Performance"
+copyright = "2025, Architecture & Performance"
 author = "Francois Pacull"
 
 # Get version from the package
 try:
     from edsger._version import __version__
+
     release = __version__
     version = __version__
 except ImportError:
@@ -69,6 +70,6 @@ myst_enable_extensions = [
 
 # Source suffix
 source_suffix = {
-    '.rst': 'restructuredtext',
-    '.md': 'markdown',
-}
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}

{edsger-0.1.0 → edsger-0.1.1}/docs/source/quickstart.md

@@ -2,6 +2,26 @@
 
 Welcome to our Python library for graph algorithms. So far, the library only includes Dijkstra's algorithm but we should add a range of common path algorithms later. It is also open-source and easy to integrate with other Python libraries.
 
+
+## Graph Data Format
+
+Edsger expects graph data as a pandas DataFrame with the following structure:
+
+| Column | Type    | Description                          |
+|--------|---------|--------------------------------------|
+| tail   | int     | Source vertex ID                     |
+| head   | int     | Destination vertex ID                |
+| weight | float   | Edge weight (must be non-negative)   |
+
+Example:
+```python
+edges = pd.DataFrame({
+    'tail': [0, 0, 1, 2],
+    'head': [1, 2, 2, 3],
+    'weight': [1.0, 4.0, 2.0, 1.0]
+})
+```
+
 ## Dijkstra's Algorithm
 
 To use Dijkstra's algorithm, you can import the `Dijkstra` class from the `path` module. The function takes a graph and a source node as input, and returns the shortest path from the source node to all other nodes in the graph.
@@ -54,7 +74,7 @@ other_edges = pd.DataFrame({
 other_dijkstra = Dijkstra(edges, tail='from', head='to', weight='travel_time')
 ```
 
-## Orientation
+### Orientation
 
 The `orientation` argument (a string with a default value of `'out'`) specifies the orientation of the algorithm. It can be either `'out'` for single source shortest paths or `'in'` for single target shortest path.
 
@@ -68,7 +88,7 @@ print("Shortest paths:", shortest_paths)
 
     Shortest paths: [ 0. inf inf inf inf]
 
-## Run Multiple Times
+### Run Multiple Times
 
 Once the Dijkstra is instantiated with a given graph and orientation, the `run` method can be called multiple times with different source vertices.
 
@@ -80,7 +100,7 @@ print("Shortest paths:", shortest_paths)
 
     Shortest paths: [5. 4. 2. 1. 0.]
 
-## Check Edges
+### Check Edges
 
 The `check_edges` argument (a boolean with a default value of `False`) validates the given graph. When set to `True`, it ensures the DataFrame is well-formed by:
 
@@ -101,7 +121,7 @@ dijkstra = Dijkstra(invalid_edges, check_edges=True)
 
     ValueError: edges['weight'] should be nonnegative
 
-## Permute
+### Permute
 
 Finally, the `permute` argument (boolean with a default value of `False`) allows to permute the IDs of the nodes. If set to `True`, the node IDs will be reindexed to start from 0 and be contiguous for the inner computations, and the output will be reindexed to the original IDs, loading the same result as if the IDs were not permuted. The permutation may save memory and computation time for large graphs, for example if a significant ratio of the nodes are not actually used in the graph.
 
@@ -140,7 +160,7 @@ shortest_paths[-5:]
 
     array([0., 1., 3., 4., 5.])
 
-## Run Method Options
+### Run Method Options
 
 The `run` method can take the following arguments besides the source/target vertex index:
 

{edsger-0.1.0 → edsger-0.1.1}/pyproject.toml

@@ -7,7 +7,7 @@ name = "edsger"
 dynamic = ["version"]
 description = "Graph algorithms in Cython."
 readme = "README.md"
-requires-python = ">=3.11"
+requires-python = ">=3.9"
 license = {text = "MIT License"}
 authors = [
     { name = "François Pacull", email = "francois.pacull@architecture-performance.fr" },
@@ -19,6 +19,11 @@ keywords = ["python", "graph", "shortest path", "Dijkstra"]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Topic :: Scientific/Engineering"
@@ -61,4 +66,8 @@ write_to_template = '__version__ = "{version}"'
 [tool.pytest.ini_options]
 testpaths = [
     "tests"
-]
+]
+
+[tool.cibuildwheel]
+# Skip 32-bit i686 architectures (outdated, rarely needed)
+skip = "*_i686"

{edsger-0.1.0 → edsger-0.1.1}/requirements-dev.txt

@@ -10,6 +10,8 @@ loguru
 pyarrow
 
 # Linting/Tooling
+cython-lint
+black
 
 # Documentation
 sphinx

{edsger-0.1.0 → edsger-0.1.1}/setup.py

@@ -1,5 +1,4 @@
-"""setup python file for edsger.
-"""
+"""setup python file for edsger."""
 
 import numpy as np
 from Cython.Build import cythonize

edsger-0.1.1/src/edsger/.gitignore

@@ -0,0 +1 @@
+_version.py

edsger-0.1.1/src/edsger/_version.py

@@ -0,0 +1 @@
+__version__ = "0.1.1"