scisoftdev-tmp-HiPOP 1.0.3__tar.gz → 1.0.7__tar.gz

{scisoftdev_tmp_hipop-1.0.3 → scisoftdev_tmp_hipop-1.0.7}/.github/workflows/deploy.yaml

@@ -2,13 +2,34 @@ name: Deploy to PyPI
 
 on:
   push:
-    workflow_dispatch: # TODO define the trigger with EMobLab once the workflow is stable
+    tags:
+      - 'v*.*.*' # Trigger on version tags like v1.2.3
+  # TODO define the trigger with EMobLab once the workflow is stable
 
 jobs:
 
+  check-version:
+    name: Check git tag
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Ensure git tag corresponds to project version
+        run: |
+          project_version="v$(tr -d '[:space:]' < VERSION.txt)"
+          echo "Git tag = [$GITHUB_REF_NAME]"
+          echo "Project version = [$project_version]"
+          if [ "$GITHUB_REF_NAME" != "$project_version" ]; then
+            echo "Mismatch between git tag and project version (VERSION.txt), aborting deployment..."
+            exit 1
+          fi
+
   build-wheels:
     name: Build wheels (${{ matrix.os }})
     runs-on: ${{ matrix.os }}
+    needs:
+      - check-version
 
     strategy:
       fail-fast: false
@@ -40,6 +61,8 @@ jobs:
   build-sdist:
     name: Build source distribution
     runs-on: ubuntu-latest
+    needs:
+      - check-version
 
     steps:
       - uses: actions/checkout@v7
@@ -62,6 +85,7 @@ jobs:
     name: Publish to PyPI
     runs-on: ubuntu-latest
     needs:
+      - check-version
       - build-wheels
       - build-sdist
     # TODO keep? if: github.event_name == 'release'
@@ -79,9 +103,5 @@ jobs:
           path: dist
           merge-multiple: true
 
-      - name: Debug # TODO to remove
-        run: |
-          ls -al dist
-
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

{scisoftdev_tmp_hipop-1.0.3 → scisoftdev_tmp_hipop-1.0.7}/.gitignore

@@ -8,6 +8,9 @@ __pycache__/
 /dist/
 /wheelhouse/
 
+# Temporary/cache directories created by miscellaneous development tools
+/.pytest_cache/
+
 # Python virtual environments (usual names)
 env/
 venv/

{scisoftdev_tmp_hipop-1.0.3 → scisoftdev_tmp_hipop-1.0.7}/CMakeLists.txt

@@ -1,7 +1,8 @@
 cmake_minimum_required(VERSION 3.19)
 
+file(STRINGS VERSION.txt HIPOP_VERSION)
 project(HiPOP
-    VERSION 0.0.3 # TODO synchronize version number with pyproject.toml
+    VERSION "${HIPOP_VERSION}"
     DESCRIPTION "High Performance Optimal Path module"
     HOMEPAGE_URL "https://github.com/EMob-Lab/HiPOP"
     LANGUAGES CXX

{scisoftdev_tmp_hipop-1.0.3 → scisoftdev_tmp_hipop-1.0.7}/PKG-INFO

@@ -1,9 +1,25 @@
 Metadata-Version: 2.4
 Name: scisoftdev-tmp-HiPOP
-Version: 1.0.3
+Version: 1.0.7
 Summary: High Performance Optimal Path module
+Keywords: graph,graph-theory,shortest-path,dijkstra
 License-Expression: LGPL-3.0-only
 License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
 Project-URL: Repository, https://github.com/EMob-Lab/HiPOP
 Project-URL: Issues, https://github.com/EMob-Lab/HiPOP/issues
 Requires-Python: >=3.10

scisoftdev_tmp_hipop-1.0.7/VERSION.txt

@@ -0,0 +1 @@
+1.0.7

scisoftdev_tmp_hipop-1.0.7/conda/env.yaml

@@ -0,0 +1,20 @@
+# Development environment for HiPOP.
+#
+# Usage:
+#   conda create -f conda/env.yaml    # Only once, to create the environment.
+#   conda activate hipop-dev          # Each time you want to work on HiPOP.
+#
+# Using this environment (and more generally, using conda) is optional:
+# if the dependencies listed here are already available on your system,
+# you can use them directly without creating a conda environment.
+#
+name: hipop-dev
+channels:
+  - conda-forge
+  - nodefaults # Disable the default Anaconda channel.
+dependencies:
+  - cmake
+  - cxx-compiler
+  - llvm-openmp # Other OpenMP implementations are OK for HiPOP, LLVM/OpenMP is not mandatory.
+  - pip
+  - python=3.10

{scisoftdev_tmp_hipop-1.0.3 → scisoftdev_tmp_hipop-1.0.7}/pyproject.toml

@@ -1,14 +1,35 @@
 [project]
-name = "scisoftdev-tmp-HiPOP" # TODO Project name modified to test deployment, to restore.
-version = "1.0.3" # TODO Project version modified to test deployment, to restore.
+name = "scisoftdev-tmp-HiPOP" # TODO Project name (and VERSION !!) modified to test deployment, to restore.
+dynamic = ["version"] # Version number is defined in file VERSION.txt.
 description = "High Performance Optimal Path module"
 readme = "README.md"
 requires-python = ">= 3.10"
 license = "LGPL-3.0-only"
 license-files = ["LICENSE"]
 # TODO authors/maintainers
-# TODO keywords
-# TODO classifiers
+keywords = [
+    "graph",
+    "graph-theory",
+    "shortest-path",
+    "dijkstra",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering",
+    "Programming Language :: C++",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+]
 
 [project.urls]
 Repository = "https://github.com/EMob-Lab/HiPOP"
@@ -16,11 +37,12 @@ Issues = "https://github.com/EMob-Lab/HiPOP/issues"
 
 [dependency-groups]
 build = [ # Dependencies needed for build tasks. Must be maintained identical to "build-system".requires
+    "dynamic-metadata >= 0.5",
+    "pybind11 >= 3.1",
     "scikit-build-core >= 1.0",
-    "pybind11", # TODO pybind11 version requirements?
 ]
 test = [ # Dependencies needed for test tasks. Must be maintained identical to tool.cibuildwheel."test-requires"
-    "pytest >= 9.0",
+    "pytest >= 9.1",
 ]
 dev = [ # All dependencies needed for development tasks.
     { include-group = "build" },
@@ -33,14 +55,23 @@ distrib = [ # Dependencies needed to build distribution files (wheels & source d
 
 [build-system]
 requires = [ # Must be maintained identical to "dependency-groups".build
+    "dynamic-metadata >= 0.5",
+    "pybind11 >= 3.1",
     "scikit-build-core >= 1.0",
-    "pybind11", # TODO pybind11 version requirements?
 ]
 build-backend = "scikit_build_core.build"
 
+[[tool.dynamic-metadata]]
+provider = "dynamic_metadata.from_file"
+field = "version"
+path = "VERSION.txt"
+
 [tool.scikit-build]
 wheel.packages = ["python/hipop"] # Location of the pure Python package to include in the wheel...
-wheel.exclude = ["**/*.cpp"]      # ... but the C++ sources of the wrapper must be excluded.
+wheel.exclude = [
+    "**/*.cpp",                   # ... but the C++ sources of the wrapper must be excluded...
+    "**/*.py.template",           # ... and so are the templates of the dynamically-generated Python files.
+]
 build-dir = "build-scikit"
 editable.verbose = true
 editable.rebuild = true
@@ -50,6 +81,10 @@ HIPOP_WITH_PYTHON = "ON"
 HIPOP_WITH_TESTS = "OFF"
 HIPOP_WITH_EXAMPLES = "OFF"
 
+[[tool.scikit-build.generate]]
+path = "hipop/__init__.py"
+template-path = "python/hipop/__init__.py.template"
+
 [tool.cibuildwheel]
 build = [ # Build Linux + Win for x64, and MacOS for ARM64. TODO is it enough?
     "*-manylinux_x86_64",
@@ -60,7 +95,7 @@ skip = [
     "cp3??t-*", # Free-threaded standard interpreter (https://docs.python.org/3/glossary.html#term-free-threading).
 ]
 test-requires = [ # Must be maintained identical to "dependency-groups".test
-    "pytest >= 9.0",
+    "pytest >= 9.1",
 ]
 test-command = "pytest {project}"
 

scisoftdev_tmp_hipop-1.0.7/python/hipop/__init__.py.template

@@ -0,0 +1 @@
+__version__ = "${version}"

scisoftdev_tmp_hipop-1.0.7/python/tests/test_VersionConsistency.py

@@ -0,0 +1,13 @@
+import hipop
+import importlib.metadata
+
+
+def test_version_consistency() -> None:
+
+    # "Package version" is the version defined in `cpp/hipop/__init__.py`.
+    package_version = hipop.__version__
+
+    # "Distribution version" is the version defined in `pyproject.toml`.
+    distribution_version = importlib.metadata.version("scisoftdev-tmp-hipop") # Name of the project in `pyproject.toml` TODO change it
+
+    assert package_version == distribution_version, "Package version and distribution version must be identical"

scisoftdev_tmp_hipop-1.0.3/bump_version.py

@@ -1,48 +0,0 @@
-import re
-from pathlib import Path
-import argparse
-
-PATTERN_VERSION = r"\d+\.\d+\.\d+"
-
-files = [("cpp/CMakeLists.txt", re.compile(rf"(project\(HiPOP VERSION )({PATTERN_VERSION})(\))")),
-         ("python/hipop/__init__.py", re.compile(rf'(__version__ = ")({PATTERN_VERSION})(")')),
-         ("conda/recipe/meta.yaml", re.compile(r'({% set version = ")('+PATTERN_VERSION+r')(" %})'))]
-
-
-def read(file):
-    with open(file, "r") as f:
-        contents = f.read()
-    return contents
-
-
-def write(file, new_contents):
-    with open(file, "w") as f:
-        f.write(new_contents)
-
-
-cwd = Path(__file__).parent.resolve()
-
-
-def show_diff(contents, new_contents):
-    for i, (lc, lnc) in enumerate(zip(contents.split("\n"), new_contents.split("\n"))):
-        if lc != lnc:
-            print(f"\tline {i}: {lc} -> {lnc}")
-
-
-if __name__ == "__main__":
-    import argparse
-    parser = argparse.ArgumentParser()
-    parser.add_argument('MAJOR', help='major version number', type=int)
-    parser.add_argument('MINOR', help='minor version number', type=int)
-    parser.add_argument('PATCH', help='patch version number', type=int)
-    args = parser.parse_args()
-
-    new_version = f"{args.MAJOR}.{args.MINOR}.{args.PATCH}"
-
-    for f, pattern in files:
-        print("Bumping version in file:", f)
-        f_path = cwd.joinpath(f)
-        contents = read(f_path)
-        new_contents = pattern.sub(f"\g<1>{new_version}\g<3>", contents, count=1)
-        show_diff(contents, new_contents)
-        write(f_path, new_contents)

scisoftdev_tmp_hipop-1.0.3/conda/env.yaml

@@ -1,17 +0,0 @@
-# Development / CI environment for HiPOP.
-#
-# Usage:
-#   conda create -f conda/env.yaml    # Only once, to create the environment.
-#   conda activate hipop-dev          # Each time you want to work on HiPOP.
-#
-name: hipop-dev
-channels:
-  - conda-forge
-  - nodefaults # Disable the default Anaconda channel. TODO still some warnings in CI logs...
-dependencies:
-  - cxx-compiler
-  - cmake
-  - ninja
-  - llvm-openmp
-  - pip
-  - python=3.10

scisoftdev_tmp_hipop-1.0.3/conda/recipe/README.md

@@ -1,11 +0,0 @@
-# Build conda pkgs
-
-You need to have the conda package `conda-build` installed in your `base` environment.
-
-At the root of `hipop` run the following command inside a terminal:
-
-```shell
-conda build . -c conda-forge --output-folder conda-bld
-```
-
-If it is a success, you will find the package inside the `conda-bld` folder.

scisoftdev_tmp_hipop-1.0.3/conda/recipe/build-hipoplib.sh

@@ -1,16 +0,0 @@
-#!/usr/bin/env bash
-set -ex
-
-cd cpp
-
-cmake \
-    -DCMAKE_PREFIX_PATH=$PREFIX\
-    -DCMAKE_INSTALL_PREFIX=$PREFIX\
-    -DBUILD_TESTS=ON\
-    -DCMAKE_BUILD_TYPE=Release\
-    -B build
-
-cmake --build build --parallel "${CPU_COUNT}"
-cmake --install build --config Release
-
-cd build && ctest

scisoftdev_tmp_hipop-1.0.3/conda/recipe/meta.yaml

@@ -1,57 +0,0 @@
-{% set version = "0.0.3" %}
-package:
-  name: hipop-pkgs
-  version: {{ version }}
-
-source:
-  path: ../..
-
-build:
-  number: 0
-  skip: true  # [win]
-
-outputs:
-  - name: hipoplib
-    version: {{ version }}
-    build:
-      script: ${RECIPE_DIR}/build-hipoplib.sh
-    requirements:
-      build:
-        - {{ compiler('cxx') }}
-        - make
-        - cmake
-        - openmp
-    test:
-      script: ${RECIPE_DIR}/test-hipoplib.sh
-
-  - name: hipop
-    version: {{ version }}
-    build:
-      script: $PYTHON -m pip install --no-deps ./python
-    requirements:
-      build:
-        - {{ compiler('cxx') }}
-        - make
-        - cmake
-        - python=3.10
-      host:
-        - python=3.10
-        - hipoplib
-        - pybind11
-      run:
-        - python=3.10
-        - hipoplib
-        - numpy
-        - matplotlib
-    test:
-      imports:
-        - hipop.cpp
-
-about:
-#  license: LGPL 3.0
-  # license_file:
-  summary: 'HiPOP is a graph implementation for traffic simulation in C++ with python bindings.'
-  description: |
-    HiPOP is a graph implementation for traffic simulation in C++ with python bindings.
-#  doc_url:
-  dev_url: https://github.com/licit-lab/HiPOP

scisoftdev_tmp_hipop-1.0.3/python/hipop/__init__.py

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