ogdf-py 0.1.1__tar.gz

ogdf_py-0.1.1/.github/workflows/build-publish.yml

@@ -0,0 +1,190 @@
+name: Build and Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+  pull_request:
+    branches: [main, master]
+  workflow_dispatch:
+    inputs:
+      publish:
+        description: "Publish to PyPI"
+        required: false
+        default: false
+        type: boolean
+
+permissions:
+  contents: read
+
+concurrency:
+  group: build-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  # Build CPython 3.10-3.13; skip musllinux (OGDF is bootstrapped on
+  # manylinux/glibc) and PyPy.
+  CIBW_BUILD: "cp310-* cp311-* cp312-* cp313-*"
+  CIBW_SKIP: "*-musllinux_* pp*"
+  # Clone + build OGDF once per platform before building any wheels. On Linux
+  # this runs inside the manylinux container (git present; install cmake).
+  CIBW_BEFORE_ALL_LINUX: >-
+    (command -v cmake >/dev/null 2>&1 || pipx install cmake) &&
+    bash scripts/bootstrap_ogdf.sh
+  CIBW_BEFORE_ALL_MACOS: bash scripts/bootstrap_ogdf.sh
+  # Exercise each wheel end-to-end (import + layouts + I/O).
+  CIBW_TEST_REQUIRES: pytest
+  CIBW_TEST_COMMAND: pytest {project}/tests -v
+
+jobs:
+  build-sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.3.0
+
+      - name: Build sdist
+        run: uv build --sdist
+
+      - name: Upload sdist
+        uses: actions/upload-artifact@v7
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+          retention-days: 14
+
+  build-wheels:
+    name: Wheels (${{ matrix.os }} / ${{ matrix.arch }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # Native runners only -- no QEMU, no cross-compilation, so the OGDF
+          # static library always matches the wheel's architecture.
+          - os: ubuntu-latest
+            arch: x86_64
+          - os: ubuntu-24.04-arm
+            arch: aarch64
+          - os: macos-15-intel
+            arch: x86_64
+            macos_target: "10.15"   # C++17 libc++ (<filesystem>) needs 10.15+
+          - os: macos-14
+            arch: arm64
+            macos_target: "11.0"
+    env:
+      MACOSX_DEPLOYMENT_TARGET: ${{ matrix.macos_target }}
+    steps:
+      - uses: actions/checkout@v7
+
+      # Cache the cloned+built OGDF per platform/arch so reruns skip the build.
+      - name: Cache OGDF
+        uses: actions/cache@v4
+        with:
+          path: thirdparty/ogdf
+          key: ogdf-${{ runner.os }}-${{ matrix.arch }}-${{ hashFiles('scripts/bootstrap_ogdf.sh') }}
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v4.1.0
+        env:
+          CIBW_ARCHS: ${{ matrix.arch }}
+
+      - name: Upload wheels
+        uses: actions/upload-artifact@v7
+        with:
+          name: wheels-${{ matrix.os }}-${{ matrix.arch }}
+          path: wheelhouse/*.whl
+          retention-days: 14
+
+  collect-artifacts:
+    name: Collect all build artifacts
+    needs: [build-sdist, build-wheels]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download all artifacts
+        uses: actions/download-artifact@v8
+        with:
+          path: dist
+          pattern: "*"
+          merge-multiple: true
+
+      - name: List all artifacts
+        run: |
+          echo "=== All build artifacts ==="
+          ls -la dist/
+          wheels=$(find dist -name '*.whl' | wc -l)
+          sdists=$(find dist -name '*.tar.gz' | wc -l)
+          echo "=== Wheels: ${wheels} | Sdists: ${sdists} ==="
+
+      - name: Upload combined artifacts
+        uses: actions/upload-artifact@v7
+        with:
+          name: all-dist
+          path: dist/
+          retention-days: 30
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    needs: collect-artifacts
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/ogdf-py
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: all-dist
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: [collect-artifacts, publish-testpypi]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    environment:
+      name: pypi
+      url: https://pypi.org/p/ogdf-py
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: all-dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-manual:
+    name: Manual publish to PyPI
+    needs: collect-artifacts
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch' && inputs.publish
+    environment:
+      name: pypi
+      url: https://pypi.org/p/ogdf-py
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: all-dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

ogdf_py-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,63 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  qa:
+    name: QA (lint, typecheck, test)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      # Cache the cloned+built OGDF so most runs skip the ~2 min build.
+      # Keyed on the bootstrap script (which pins the OGDF tag).
+      - name: Cache OGDF
+        uses: actions/cache@v4
+        with:
+          path: thirdparty/ogdf
+          key: ogdf-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('scripts/bootstrap_ogdf.sh') }}
+
+      - name: Bootstrap OGDF
+        run: ./scripts/bootstrap_ogdf.sh
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.3.0
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.13
+
+      - name: Install dependencies (builds the extension)
+        run: uv sync --dev
+
+      - name: Lint with ruff
+        run: uv run ruff check src/ tests/
+
+      - name: Check formatting with ruff
+        run: uv run ruff format --check src/ tests/
+
+      - name: Type check with mypy
+        run: uv run mypy src/ogdf tests/
+
+      - name: Run tests
+        run: uv run pytest tests/ -v --cov=src/ogdf --cov-report=xml
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v7
+        with:
+          files: coverage.xml
+          fail_ci_if_error: false
+          token: ${{ secrets.CODECOV_TOKEN }}

ogdf_py-0.1.1/.gitignore

@@ -0,0 +1,46 @@
+# Build
+build/
+dist/
+*.egg-info/
+*.so
+*.pyd
+
+# folders
+thirdparty/
+
+# Virtual environments
+.venv/
+venv/
+.uv/
+
+# Cache
+__pycache__/
+*.pyc
+*.pyo
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# Coverage
+.coverage
+coverage.xml
+htmlcov/
+
+# CMake
+CMakeCache.txt
+CMakeFiles/
+cmake_install.cmake
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*~
+
+# OS
+.DS_Store
+
+# agentic
+.claude
+CLAUDE.md
+

ogdf_py-0.1.1/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.1]
+
+### Added
+
+- OGDF bindings (curated subset): `Graph`/`Node`/`Edge` with iteration; `NodeArray`/`EdgeArray` in int/double/bool; `GraphAttributes` with coordinates, size, labels, and styling (colors, shapes, fill patterns, stroke, edge arrows, bends).
+
+- Layout algorithms: `SugiyamaLayout`, `FMMMLayout`, `GEMLayout`, `SpringEmbedderKK`, `StressMinimization`, `PivotMDS`, `PlanarizationLayout` (with optional orthogonal routing), `SchnyderLayout`, `TreeLayout`, `CircularLayout`.
+
+- Core graph algorithms: connectivity/structure predicates, connected / strong / biconnected components, topological numbering, Dijkstra shortest paths, minimum spanning tree, maximum flow, global minimum cut, matching, node coloring, and planar embedding.
+
+- Graph generators: complete, complete-bipartite, wheel, cube, grid, Petersen, regular tree, plus random graphs, trees, digraphs, and regular / biconnected / planar variants.
+
+- File I/O: interchange formats GML, GraphML, DOT, GEXF, GDF, TLP (with extension-based `read`/`write`) and drawing output as SVG and TikZ.
+
+- `demos/` folder with illustrative scripts (layout gallery, styling showcase, algorithm visualizations, generator zoo, I/O round-trips) writing to `build/demo-output`; `make demos` also builds a self-contained HTML gallery (`index.html`) of every drawing.
+
+- Bindings split into modular translation units (`bind_graph`, `bind_layouts`, `bind_algorithms`, `bind_io`, `bind_generators`).
+
+- Auto-generated `_core.pyi` type stub for typed usage and IDE completion.
+
+- `cibuildwheel` release workflow building CPython 3.10-3.13 wheels for Linux (x86_64, aarch64) and macOS (x86_64, arm64) on native runners, bootstrapping OGDF once per platform; trusted-publishing jobs for TestPyPI/PyPI on tags.
+
+- CMake auto-bootstraps OGDF if missing, so `pip install` from an sdist works without a manual step (Unix only).
+
+### Changed
+
+- Reproducible OGDF dependency: `scripts/bootstrap_ogdf.sh` shallow-clones OGDF at a pinned tag (`foxglove-202510`) and builds its static libraries from source; the extension links them. `make build`/`make sync` auto-bootstrap if needed. Replaces reliance on a manually placed OGDF checkout.
+
+- Persist the CMake build directory so only the bindings recompile on edits.
+
+### Fixed
+
+- `make build` targeted the wrong package name (`ogdf` vs `ogdf-py`), making it a silent no-op; it now rebuilds correctly.
+
+- The generic `write` now raises `ValueError` for attribute-incapable formats (e.g. LEDA, Chaco) instead of crashing the interpreter.
+
+## [0.1.0] - 2026-07-06
+
+### Added
+
+- Initial project structure
+
+- Core module with example functions
+
+- Test suite with pytest
+
+- Build system using scikit-build-core

ogdf_py-0.1.1/CMakeLists.txt

@@ -0,0 +1,88 @@
+cmake_minimum_required(VERSION 3.15...3.31)
+project(${SKBUILD_PROJECT_NAME} VERSION ${SKBUILD_PROJECT_VERSION} LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+find_package(Python REQUIRED COMPONENTS Interpreter Development.Module)
+find_package(nanobind CONFIG REQUIRED)
+find_package(Threads REQUIRED)
+
+# --- OGDF (prebuilt static libraries) ---------------------------------------
+# OGDF is cloned at a pinned tag and built from source by
+# scripts/bootstrap_ogdf.sh, which produces libOGDF.a / libCOIN.a and the
+# generated config header. We link those static libs into the extension.
+set(OGDF_ROOT "${CMAKE_SOURCE_DIR}/thirdparty/ogdf")
+set(OGDF_BUILD "${OGDF_ROOT}/build")
+
+# If OGDF has not been built yet, try to bootstrap it automatically (clone the
+# pinned tag + build from source). This lets `pip install` from an sdist work
+# without a separate manual step. Windows is not supported by the bash script.
+if(NOT EXISTS "${OGDF_BUILD}/libOGDF.a"
+   AND EXISTS "${CMAKE_SOURCE_DIR}/scripts/bootstrap_ogdf.sh"
+   AND NOT WIN32)
+    message(STATUS "OGDF not built; running scripts/bootstrap_ogdf.sh ...")
+    execute_process(
+        COMMAND bash "${CMAKE_SOURCE_DIR}/scripts/bootstrap_ogdf.sh"
+        RESULT_VARIABLE _ogdf_bootstrap_result)
+    if(NOT _ogdf_bootstrap_result EQUAL 0)
+        message(FATAL_ERROR
+            "OGDF bootstrap failed (exit ${_ogdf_bootstrap_result}).")
+    endif()
+endif()
+
+if(NOT EXISTS "${OGDF_BUILD}/libOGDF.a")
+    message(FATAL_ERROR
+        "Prebuilt OGDF not found at ${OGDF_BUILD}/libOGDF.a.\n"
+        "Run the bootstrap script first:\n"
+        "    scripts/bootstrap_ogdf.sh\n"
+        "(or `make bootstrap`), which clones OGDF at a pinned tag and builds it.")
+endif()
+
+# Public headers plus the build-time generated config header
+# (config_autogen.h lives under build/include/ogdf-release).
+set(OGDF_INCLUDE_DIRS
+    "${OGDF_ROOT}/include"
+    "${OGDF_BUILD}/include/ogdf-release")
+
+set(OGDF_LIBRARIES
+    "${OGDF_BUILD}/libOGDF.a"
+    "${OGDF_BUILD}/libCOIN.a"
+    Threads::Threads)
+
+nanobind_add_module(_core
+    src/ogdf/_core.cpp
+    src/ogdf/bind_graph.cpp
+    src/ogdf/bind_layouts.cpp
+    src/ogdf/bind_algorithms.cpp
+    src/ogdf/bind_io.cpp
+    src/ogdf/bind_generators.cpp)
+
+target_include_directories(_core PRIVATE ${OGDF_INCLUDE_DIRS})
+target_link_libraries(_core PRIVATE ${OGDF_LIBRARIES})
+
+if(MSVC)
+    target_compile_options(_core PRIVATE /W4)
+else()
+    target_compile_options(_core PRIVATE -Wall -Wextra)
+endif()
+
+install(TARGETS _core DESTINATION ogdf)
+
+# Generate a type stub (_core.pyi) so the compiled module is typed for mypy and
+# IDEs. nanobind imports the built module and introspects it at build time.
+nanobind_add_stub(
+    _core_stub
+    MODULE _core
+    OUTPUT _core.pyi
+    PYTHON_PATH $<TARGET_FILE_DIR:_core>
+    DEPENDS _core
+)
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/_core.pyi DESTINATION ogdf)
+
+# Ship py.typed alongside the compiled module + stub. In an editable install the
+# pure-Python files (including src/ogdf/py.typed) stay in the source tree, so
+# without this the site-packages ogdf/ dir has _core.pyi but no py.typed marker,
+# and mypy refuses to use the stub.
+install(FILES ${CMAKE_SOURCE_DIR}/src/ogdf/py.typed DESTINATION ogdf)

ogdf_py-0.1.1/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2026 Shakeeb Alireza
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ogdf_py-0.1.1/Makefile

@@ -0,0 +1,157 @@
+# Makefile frontend for scikit-build-core project
+# Generated by buildgen for: ogdf
+#
+# This Makefile wraps common build commands for convenience.
+# The actual build is handled by scikit-build-core via pyproject.toml
+
+.PHONY: all bootstrap sync build rebuild test demos lint lint-check format format-check         typecheck qa clean distclean wheel sdist dist check publish-test         publish upgrade coverage coverage-html docs release help
+
+# Prebuilt OGDF static library; its presence marks a completed bootstrap.
+OGDF_LIB := thirdparty/ogdf/build/libOGDF.a
+
+# Default target
+all: build
+
+# Clone OGDF at the pinned tag and build its static libraries from source.
+bootstrap:
+	@./scripts/bootstrap_ogdf.sh
+
+# Auto-bootstrap: build OGDF only if it has not been built yet.
+$(OGDF_LIB):
+	@./scripts/bootstrap_ogdf.sh
+
+# Sync environment (initial setup, installs dependencies + package)
+sync: $(OGDF_LIB)
+	@uv sync
+
+# Build/rebuild the extension after code changes.
+# The distribution is named "ogdf-py" (see pyproject.toml); --refresh-package
+# busts uv's build cache so C++ source edits are actually recompiled.
+build: $(OGDF_LIB)
+	@uv sync --reinstall-package ogdf-py --refresh-package ogdf-py
+
+# Alias for build
+rebuild: build
+
+# Run tests
+test:
+	@uv run pytest tests/ -v
+
+# Run the illustrative demos (writes SVGs and data files to build/demo-output)
+demos:
+	@uv run python demos/run_all.py
+
+# Lint with ruff (applies fixes)
+lint:
+	@uv run ruff check --fix src/ tests/
+
+# Lint with ruff (check only, no fixes)
+lint-check:
+	@uv run ruff check src/ tests/
+
+# Format with ruff
+format:
+	@uv run ruff format src/ tests/
+
+# Check formatting without modifying files
+format-check:
+	@uv run ruff format --check src/ tests/
+
+# Type check with mypy
+typecheck:
+	@uv run mypy src/ogdf
+
+# Run a full quality assurance check (non-mutating; mirrors CI)
+qa: lint-check format-check typecheck test
+
+# Build wheel
+wheel:
+	@uv build --wheel
+
+# Build source distribution
+sdist:
+	@uv build --sdist
+
+# Check distributions with twine
+check:
+	@uv run twine check dist/*
+
+# Build both wheel and sdist
+dist: wheel sdist check
+
+# Publish to TestPyPI
+publish-test: check
+	@uv run twine upload --repository testpypi dist/*
+
+# Publish to PyPI
+publish: check
+	@uv run twine upload dist/*
+
+# Upgrade all dependencies
+upgrade:
+	@uv lock --upgrade
+	@uv sync
+
+# Run tests with coverage
+coverage:
+	@uv run pytest tests/ -v --cov=src/ogdf --cov-report=term-missing
+
+# Generate HTML coverage report
+coverage-html:
+	@uv run pytest tests/ -v --cov=src/ogdf --cov-report=html
+	@echo "Coverage report: htmlcov/index.html"
+
+# Build documentation (requires sphinx in dev dependencies)
+docs:
+	@uv run sphinx-build -b html docs/ docs/_build/html
+
+# Create a release (bump version, tag, push)
+release:
+	@echo "Current version: $$(grep '^version' pyproject.toml | head -1)"
+	@read -p "New version: " version; 	sed "s/^version = .*/version = \"$$version\"/" pyproject.toml > pyproject.toml.tmp && mv pyproject.toml.tmp pyproject.toml; 	git add pyproject.toml; 	git commit -m "Bump version to $$version"; 	git tag -a "v$$version" -m "Release $$version"; 	echo "Tagged v$$version. Run 'git push && git push --tags' to publish."
+
+# Clean build artifacts
+clean:
+	@rm -rf build/
+	@rm -rf dist/
+	@rm -rf *.egg-info/
+	@rm -rf src/*.egg-info/
+	@rm -rf .pytest_cache/
+	@find . -name "*.so" -delete
+	@find . -name "*.pyd" -delete
+	@find . -name "__pycache__" -type d -exec rm -rf {} + 2>/dev/null || true
+
+# Clean everything including CMake cache
+distclean: clean
+	@rm -rf CMakeCache.txt CMakeFiles/
+
+# Show help
+help:
+	@echo "Available targets:"
+	@echo "  all          - Build/rebuild the extension (default)"
+	@echo "  bootstrap    - Clone OGDF at the pinned tag and build it from source"
+	@echo "  sync         - Sync environment (initial setup)"
+	@echo "  build        - Rebuild extension after code changes"
+	@echo "  rebuild      - Alias for build"
+	@echo "  test         - Run tests"
+	@echo "  demos        - Run demos (output to build/demo-output)"
+	@echo "  lint         - Lint with ruff (applies fixes)"
+	@echo "  lint-check   - Lint with ruff (check only)"
+	@echo "  format       - Format with ruff"
+	@echo "  format-check - Check formatting without modifying files"
+	@echo "  typecheck    - Type check with mypy"
+	@echo "  qa           - Run full quality assurance (non-mutating: lint-check, format-check, typecheck, test)"
+	@echo "  wheel        - Build wheel distribution"
+	@echo "  sdist        - Build source distribution"
+	@echo "  dist         - Build both wheel and sdist"
+	@echo "  check        - Check distributions with twine"
+	@echo "  publish-test - Publish to TestPyPI"
+	@echo "  publish      - Publish to PyPI"
+	@echo "  upgrade      - Upgrade all dependencies"
+	@echo "  coverage     - Run tests with coverage"
+	@echo "  coverage-html- Generate HTML coverage report"
+	@echo "  docs         - Build documentation with Sphinx"
+	@echo "  release      - Bump version, tag, and prepare release"
+	@echo "  clean        - Remove build artifacts"
+	@echo "  distclean    - Remove all generated files"
+	@echo "  help         - Show this help message"