navyfox 0.1.2__tar.gz

navyfox-0.1.2/.github/workflows/build-native.yml

@@ -0,0 +1,116 @@
+name: Build Native Binaries
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  build-linux:
+    name: Build ${{ matrix.rid }}
+    runs-on: ${{ matrix.os }}
+    container: ${{ matrix.container }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - rid: linux-x64
+            os: ubuntu-24.04
+            lib_name: NavyFox.Native.so
+            container: quay.io/pypa/manylinux_2_28_x86_64
+          - rid: linux-arm64
+            os: ubuntu-24.04-arm
+            lib_name: NavyFox.Native.so
+            container: quay.io/pypa/manylinux_2_28_aarch64
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install native build tools
+        run: yum install -y clang zlib-devel libxml2-devel
+
+      - name: Install .NET 9
+        run: |
+          curl -sSL https://dot.net/v1/dotnet-install.sh | bash -s -- --channel 9.0 --install-dir /usr/local/dotnet
+          echo "/usr/local/dotnet" >> $GITHUB_PATH
+          echo "DOTNET_ROOT=/usr/local/dotnet" >> $GITHUB_ENV
+          echo "DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1" >> $GITHUB_ENV
+
+      - name: Publish Native AOT shared library
+        run: >
+          dotnet publish native/NavyFox.Native/NavyFox.Native.csproj
+          -r ${{ matrix.rid }}
+          -c Release
+          --self-contained true
+          -p:PublishAot=true
+          -p:NativeLib=Shared
+          -p:StripSymbols=true
+          -p:InvariantGlobalization=true
+          -o publish/${{ matrix.rid }}
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: native-${{ matrix.rid }}
+          path: publish/${{ matrix.rid }}/
+          if-no-files-found: error
+          retention-days: 7
+
+  build-other:
+    name: Build ${{ matrix.rid }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - rid: win-x64
+            os: windows-2022
+            lib_name: NavyFox.Native.dll
+            publish_props: ""
+          - rid: win-arm64
+            os: windows-11-arm
+            lib_name: NavyFox.Native.dll
+            publish_props: ""
+          - rid: osx-arm64
+            os: macos-15
+            lib_name: NavyFox.Native.dylib
+            publish_props: "-p:MacOSXDeploymentTarget=12.0"
+          - rid: osx-x64
+            os: macos-15
+            lib_name: NavyFox.Native.dylib
+            publish_props: "-p:MacOSXDeploymentTarget=12.0"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup .NET 9
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: "9.0.x"
+
+      - name: Publish Native AOT shared library
+        run: >
+          dotnet publish native/NavyFox.Native/NavyFox.Native.csproj
+          -r ${{ matrix.rid }}
+          -c Release
+          --self-contained true
+          -p:PublishAot=true
+          -p:NativeLib=Shared
+          -p:StripSymbols=true
+          ${{ matrix.publish_props }}
+          -o publish/${{ matrix.rid }}
+
+      - name: Fix dylib install name (macOS)
+        if: runner.os == 'macOS'
+        run: install_name_tool -id @rpath/${{ matrix.lib_name }} publish/${{ matrix.rid }}/${{ matrix.lib_name }}
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: native-${{ matrix.rid }}
+          path: publish/${{ matrix.rid }}/
+          if-no-files-found: error
+          retention-days: 7

navyfox-0.1.2/.github/workflows/ci.yml

@@ -0,0 +1,75 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  dotnet:
+    name: .NET build & tests
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup .NET 9
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: "9.0.x"
+
+      - name: Restore
+        run: dotnet restore native/NavyFox.Native/NavyFox.Native.csproj
+
+      - name: Build (TreatWarningsAsErrors + AOT analyser)
+        run: >
+          dotnet build native/NavyFox.Native/NavyFox.Native.csproj
+          -c Release
+          -p:TreatWarningsAsErrors=true
+          -p:EnableAotAnalyzer=true
+          --no-restore
+
+      - name: Run C# xUnit tests
+        run: >
+          dotnet test tests/native/NavyFox.Native.Tests/NavyFox.Native.Tests.csproj
+          -c Release
+          --logger "console;verbosity=normal"
+
+  struct-layout-check:
+    name: Struct layout check
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Run check_struct_layouts.py
+        run: python scripts/check_struct_layouts.py
+
+  python:
+    name: Python lint, type-check & unit tests
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dev dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install "mypy>=1.11" "ruff>=0.6" "pytest>=8" "pytest-cov>=5" "python-docx>=1.1" "maturin>=1.0" "twine>=5"
+
+      - name: ruff check
+        run: ruff check src/navyfox tests
+
+      - name: mypy --strict
+        run: mypy --strict src/navyfox
+
+      - name: pytest (unit only)
+        run: pytest tests/unit/ -v --tb=short

navyfox-0.1.2/.github/workflows/docs.yml

@@ -0,0 +1,54 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build Sphinx docs
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install docs dependencies
+        run: pip install "sphinx>=8" "furo>=2024" "sphinx-autoapi>=3.3" "myst-parser>=4"
+
+      - name: Build HTML
+        run: sphinx-build -b html docs docs/_build/html
+
+      - name: Upload Pages artifact
+        if: github.ref == 'refs/heads/main'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-24.04
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy
+        id: deployment
+        uses: actions/deploy-pages@v4

navyfox-0.1.2/.github/workflows/release.yml

@@ -0,0 +1,171 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: write  # create GitHub releases and upload assets
+  actions: read    # download artifacts from reusable workflow jobs
+
+jobs:
+  build-native:
+    uses: ./.github/workflows/build-native.yml
+
+  build-wheel:
+    name: Build wheel (${{ matrix.rid }})
+    runs-on: ${{ matrix.os }}
+    needs: build-native
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - rid: linux-x64
+            os: ubuntu-24.04
+            rust_target: x86_64-unknown-linux-gnu
+            manylinux: "2_28"
+            lib_name: NavyFox.Native.so
+          - rid: linux-arm64
+            os: ubuntu-24.04-arm
+            rust_target: aarch64-unknown-linux-gnu
+            manylinux: "2_28"
+            lib_name: NavyFox.Native.so
+          - rid: win-x64
+            os: windows-2022
+            rust_target: x86_64-pc-windows-msvc
+            lib_name: NavyFox.Native.dll
+          - rid: win-arm64
+            os: windows-11-arm
+            rust_target: aarch64-pc-windows-msvc
+            lib_name: NavyFox.Native.dll
+          - rid: osx-arm64
+            os: macos-15
+            rust_target: aarch64-apple-darwin
+            lib_name: NavyFox.Native.dylib
+          - rid: osx-x64
+            os: macos-15
+            rust_target: x86_64-apple-darwin
+            lib_name: NavyFox.Native.dylib
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download native binary
+        uses: actions/download-artifact@v4
+        with:
+          name: native-${{ matrix.rid }}
+          path: src/navyfox/_libs/${{ matrix.rid }}/
+
+      - name: Remove .gitkeep placeholders
+        shell: bash
+        run: find src/navyfox/_libs -name '.gitkeep' -delete
+
+      - name: Setup Python
+        if: runner.os != 'Linux'
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build wheel
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.rust_target }}
+          manylinux: ${{ matrix.manylinux || 'off' }}
+          args: --release --out dist --find-interpreter
+
+      - name: Bundle dylib with delocate (macOS)
+        if: runner.os == 'macOS'
+        run: |
+          pip install delocate
+          delocate-wheel -w dist/repaired/ -v dist/*.whl
+          rm dist/*.whl
+          mv dist/repaired/*.whl dist/
+
+      - name: Bundle DLL with delvewheel (Windows)
+        if: runner.os == 'Windows'
+        shell: bash
+        run: |
+          pip install delvewheel
+          delvewheel repair --add-path "src/navyfox/_libs/${{ matrix.rid }}/" dist/*.whl -w dist/repaired/
+          rm dist/*.whl
+          mv dist/repaired/*.whl dist/
+
+      - name: Stage native binary as release asset
+        shell: bash
+        run: |
+          mkdir -p native_asset
+          cp src/navyfox/_libs/${{ matrix.rid }}/${{ matrix.lib_name }} \
+             native_asset/${{ matrix.rid }}-${{ matrix.lib_name }}
+
+      - name: Upload native binary to GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          files: native_asset/${{ matrix.rid }}-${{ matrix.lib_name }}
+          fail_on_unmatched_files: true
+
+      - name: Upload wheel to GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          files: dist/*.whl
+          fail_on_unmatched_files: true
+
+      - name: Upload wheel artifact for PyPI
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.rid }}
+          path: dist/*.whl
+
+  build-sdist:
+    name: Build sdist
+    runs-on: ubuntu-24.04
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+
+      - name: Upload sdist to GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          files: dist/*.tar.gz
+          fail_on_unmatched_files: true
+
+      - name: Upload sdist artifact for PyPI
+        uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  publish:
+    name: Publish to PyPI
+    needs: [build-wheel, build-sdist]
+    runs-on: ubuntu-24.04
+    environment:
+      name: pypi
+      url: https://pypi.org/p/navyfox
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: wheels-*
+          merge-multiple: true
+          path: dist/
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: sdist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

navyfox-0.1.2/.gitignore

@@ -0,0 +1,71 @@
+# Python
+__pycache__/
+*.dist-info/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+.uv/
+
+# Rust build artifacts
+target/
+
+# Maturin — compiled extension artifacts (platform-specific, regenerated by maturin develop)
+src/navyfox/_navyfox*.so
+src/navyfox/_navyfox*.pyd
+
+# Coverage
+.coverage
+coverage.xml
+htmlcov/
+
+# Pytest
+.pytest_cache/
+
+# Mypy
+.mypy_cache/
+
+# Ruff
+.ruff_cache/
+
+# Jupyter / notebooks
+.ipynb_checkpoints/
+notebooks/
+
+# .NET / C#
+bin/
+obj/
+publish/
+*.user
+.vs/
+*.nupkg
+*.pdb
+*.ilk
+*.exp
+*.lib
+TestResults/
+
+# Benchmark artifacts
+scripts/benchmark_results.json
+
+# Scratch / test output
+artifacts/
+*.docx
+
+# Env / secrets
+.env
+.env.*
+secrets.toml
+
+# Logs
+*.log
+
+# OS
+.DS_Store
+Thumbs.db
+
+# IDE / tools
+.claude/
+.vscode/
+.idea/

navyfox-0.1.2/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to NavyFox 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]
+
+### Added
+
+- Initial project scaffold.
+- C# Native AOT shared library (`NavyFox.Native`) targeting net9.0 with
+  DocumentFormat.OpenXml 3.5.1.
+- Python package `navyfox` with `Document`, `Paragraph`, `Table`, and `Cell`
+  classes.
+- Platform-aware lazy binary loader (`navyfox._native.loader`).
+- CFFI bindings matching the C# `[UnmanagedCallersOnly]` exports.
+- `check_struct_layouts.py` CI guard for FFI struct annotations.
+- GitHub Actions workflows: `build-native`, `ci`, `release`.
+
+## [0.1.1] — 2026-06-18
+
+### Fixed
+
+- Release workflow: add `hatchling` to build tool installs so `python -m build --no-isolation` can find the build backend.
+
+## [0.1.0] — Unreleased

navyfox-0.1.2/Cargo.lock

@@ -0,0 +1,173 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "indoc"
+version = "2.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706"
+dependencies = [
+ "rustversion",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.186"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66"
+
+[[package]]
+name = "memoffset"
+version = "0.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "navyfox"
+version = "0.1.2"
+dependencies = [
+ "pyo3",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.13.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.25.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8970a78afe0628a3e3430376fc5fd76b6b45c4d43360ffd6cdd40bdde72b682a"
+dependencies = [
+ "indoc",
+ "libc",
+ "memoffset",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+ "unindent",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.25.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "458eb0c55e7ece017adeba38f2248ff3ac615e53660d7c71a238d7d2a01c7598"
+dependencies = [
+ "once_cell",
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.25.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7114fe5457c61b276ab77c5055f206295b812608083644a5c5b2640c3102565c"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.25.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a8725c0a622b374d6cb051d11a0983786448f7785336139c3c94f5aa6bef7e50"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.25.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4109984c22491085343c05b0dbc54ddc405c3cf7b4374fc533f5c3313a572ccc"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "pyo3-build-config",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.45"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rustversion"
+version = "1.0.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
+
+[[package]]
+name = "syn"
+version = "2.0.118"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1b9ae57f904213ebb649ce6895b8a66c66f0203b9319718f69a5612a065b1422"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.13.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "adb6935a6f5c20170eeceb1a3835a49e12e19d792f6dd344ccc76a985ca5a6ca"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "unindent"
+version = "0.2.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7264e107f553ccae879d21fbea1d6724ac785e8c3bfc762137959b5802826ef3"

navyfox-0.1.2/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "navyfox"
+version = "0.1.2"
+edition = "2021"
+readme = "README.md"
+
+[lib]
+name = "_navyfox"
+crate-type = ["cdylib"]
+
+[dependencies]
+pyo3 = { version = "0.25", features = ["extension-module"] }