python-calamine-reducto 0.7.6__tar.gz

python_calamine_reducto-0.7.6/.github/workflows/CI.yml

@@ -0,0 +1,67 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+
+jobs:
+  test:
+    name: test ${{ matrix.python-version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+
+    runs-on: ubuntu-latest
+
+    env:
+      PYTHON: ${{ matrix.python-version }}
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: configure git for private deps
+        run: git config --global url."https://x-access-token:${{ secrets.GH_PAT }}@github.com/".insteadOf "https://github.com/"
+
+      - name: install rust stable
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+
+      - id: cache-rust
+        name: cache rust
+        uses: Swatinem/rust-cache@v2
+        with:
+          key: v3
+
+      - name: set up python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - run: pip install pytest numpy
+
+      - run: pip install -e .
+        env:
+          RUST_BACKTRACE: 1
+          CARGO_NET_GIT_FETCH_WITH_CLI: "true"
+
+      - run: pytest
+
+  # https://github.com/marketplace/actions/alls-green#why used for branch protection checks
+  check:
+    if: always()
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}
+
+

python_calamine_reducto-0.7.6/.gitignore

@@ -0,0 +1,141 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# Initial .gitignore from GitHub for Python project
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# IDE stuff
+.vscode

python_calamine_reducto-0.7.6/.pre-commit-config.yaml

@@ -0,0 +1,64 @@
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v4.5.0
+      hooks:
+          - id: check-added-large-files
+          - id: check-toml
+          - id: check-yaml
+            args:
+                - --unsafe
+          - id: end-of-file-fixer
+          - id: trailing-whitespace
+    - repo: https://github.com/asottile/pyupgrade
+      rev: v3.15.0
+      hooks:
+          - id: pyupgrade
+            args:
+                - --py3-plus
+                - --keep-runtime-typing
+    - repo: https://github.com/charliermarsh/ruff-pre-commit
+      rev: v0.2.1
+      hooks:
+          - id: ruff
+            args:
+                - --fix
+    - repo: https://github.com/pycqa/isort
+      rev: 5.13.2
+      hooks:
+          - id: isort
+            name: isort (python)
+          - id: isort
+            name: isort (pyi)
+            types: [pyi]
+    - repo: https://github.com/psf/black
+      rev: 24.1.1
+      hooks:
+          - id: black
+    - repo: local
+      hooks:
+        - id: mypy
+          name: mypy
+          entry: mypy
+          language: python
+          pass_filenames: false
+        - id: mypy-stubtest
+          name: mypy-stubtest
+          entry: stubtest
+          args:
+            - python_calamine
+          language: python
+          pass_filenames: false
+    -   repo: local
+        hooks:
+        -   id: rust-linting
+            name: Rust linting
+            entry: cargo fmt --all -- --config group_imports=StdExternalCrate,imports_granularity=Module
+            pass_filenames: true
+            types: [rust]
+            language: system
+        -   id: rust-clippy
+            name: Rust clippy
+            entry: cargo clippy -- -D warnings -A incomplete_features -W clippy::dbg_macro -W clippy::print_stdout
+            pass_filenames: false
+            types: [rust]
+            language: system

python_calamine_reducto-0.7.6/.python-version

@@ -0,0 +1 @@
+3.11

python_calamine_reducto-0.7.6/CLAUDE.md

@@ -0,0 +1,131 @@
+# Reducto python-calamine Fork
+
+Private fork of [dimastbk/python-calamine](https://github.com/dimastbk/python-calamine) — PyO3 bindings for the calamine Rust spreadsheet reader.
+
+## What This Repo Is
+
+Python bindings for calamine, extended with Reducto's `CellGrid` type and workbook style/layout/bounds APIs. Used by `api4/src/sheets/` as a 40x faster replacement for openpyxl.
+
+**Dependency chain:** `api4` → `python-calamine-reducto` (PyPI) → `reductoai/calamine` + `reductoai/ssfmt` (Rust crates, compiled into the wheel)
+
+## Building
+
+```bash
+# Create venv and install
+python3 -m venv .venv && source .venv/bin/activate
+maturin develop          # debug build (~4s incremental)
+maturin develop --release  # release build (~30s clean)
+
+# Or build into api4's venv directly:
+source /path/to/api4/.venv/bin/activate
+maturin develop --release
+```
+
+Requires Rust toolchain (`rustup`). The Cargo.toml pulls `reductoai/calamine` and `reductoai/ssfmt` from git, which are private — you need git auth configured:
+```bash
+git config --global url."https://x-access-token:YOUR_PAT@github.com/".insteadOf "https://github.com/"
+# OR just have SSH access to reductoai org
+```
+
+## Testing
+
+```bash
+pip install pytest numpy
+pytest                    # all tests
+pytest tests/test_grid.py # CellGrid tests only
+pytest tests/test_base.py # upstream tests only
+```
+
+The test fixture `tests/data/grid_test.xlsx` is generated by `tests/create_test_fixture.py` (requires openpyxl). Regenerate if you change test expectations:
+```bash
+pip install openpyxl
+python tests/create_test_fixture.py
+```
+
+## Publishing to PyPI
+
+**Package name convention:** Reducto forks are published as `{package}-reducto` on PyPI. This package is `python-calamine-reducto`. The Python import stays `python_calamine`.
+
+**Steps to publish a new version:**
+
+1. Update version in `Cargo.toml` (e.g., `version = "0.7.1"`)
+2. Commit, merge to `main`, and tag:
+   ```bash
+   git tag v0.7.1
+   git push origin v0.7.1
+   ```
+3. Build wheels for each target platform:
+   ```bash
+   # macOS ARM (native):
+   maturin build --release --interpreter 3.11 3.12 3.13
+
+   # manylinux x86_64 (from macOS, via Docker):
+   docker run --rm --platform linux/amd64 \
+     --entrypoint /bin/bash \
+     -v $(pwd):/io \
+     -v $HOME/.ssh:/root/.ssh:ro \
+     -e CARGO_NET_GIT_FETCH_WITH_CLI=true \
+     -e GIT_SSH_COMMAND="ssh -o StrictHostKeyChecking=no" \
+     ghcr.io/pyo3/maturin -c '
+       git config --global url."git@github.com:".insteadOf "https://github.com/"
+       maturin build --release --interpreter 3.11 3.12 3.13
+     '
+   ```
+   Wheels go into `target/wheels/`.
+
+   **Note:** The Docker command mounts your SSH keys for private repo access. Ensure Docker Desktop is running and you have SSH access to `reductoai` org repos.
+
+4. Upload to PyPI:
+   ```bash
+   pip install twine
+   twine upload target/wheels/*
+   ```
+   Uses token from `~/.pypirc`. If not configured:
+   ```ini
+   # ~/.pypirc
+   [pypi]
+     username = __token__
+     password = pypi-...
+   ```
+
+5. Update api4's `pyproject.toml`:
+   ```
+   "python-calamine-reducto==0.7.1"
+   ```
+   Then run `uv lock`.
+
+**Note:** Because this package has private git dependencies (`reductoai/calamine`, `reductoai/ssfmt`), you need git auth configured when building. The `GH_PAT` or SSH access must be available during `maturin build`.
+
+## Key Files
+
+| Path | What |
+|------|------|
+| `src/types/grid.rs` | CellGrid, CellProxy, CellGridView — the core Reducto addition (~1500 lines) |
+| `src/types/workbook.rs` | get_sheet_grid, get_sheet_styles, get_sheet_layout, get_sheet_bounds |
+| `src/types/mod.rs` | Module exports |
+| `src/lib.rs` | PyO3 module registration |
+| `python/python_calamine/__init__.py` | Python re-exports |
+| `Cargo.toml` | Points calamine + ssfmt deps to reductoai forks |
+| `tests/test_grid.py` | 86 tests for all CellGrid APIs |
+
+## Architecture
+
+```
+Python code
+  → python_calamine (PyO3 module)
+    → CellGrid (src/types/grid.rs)     — 2D grid with per-cell value/style/formatting
+    → CalamineWorkbook (src/types/workbook.rs) — xlsx/xls/ods reader
+      → calamine (Rust crate, from reductoai/calamine) — parsing + styles
+      → ssfmt (Rust crate, from reductoai/ssfmt) — ECMA-376 number formatting
+```
+
+**CellGrid fields per cell:** value, formatted_value, font_bold, font_size, number_format, cell_textcolor, cell_highlight, cell_formula, header, is_merged, merge_parent, coord
+
+## Making Changes
+
+1. Branch from `main`
+2. Edit Rust code, rebuild with `maturin develop`
+3. Run `pytest` to verify
+4. Push, open PR against `main`
+
+If you changed something in `reductoai/calamine` or `reductoai/ssfmt`, merge those PRs first — this repo's `Cargo.toml` tracks `branch = "main"` for both.