office-stencil 0.1.0__tar.gz

office_stencil-0.1.0/.github/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+
+updates:
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 5
+    commit-message:
+      prefix: "deps"
+      include: "scope"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 5
+    commit-message:
+      prefix: "ci"
+      include: "scope"

office_stencil-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,48 @@
+name: Publish to PyPI
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Test, build, and publish
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run tests
+        run: uv run pytest
+
+      - name: Run lint
+        run: uv run ruff check .
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

office_stencil-0.1.0/.gitignore

@@ -0,0 +1,225 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+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
+.cache/
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Local development docs and planning notes
+docs/
+
+# Rendered example outputs
+examples/out/

office_stencil-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bin Zhang
+
+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.

office_stencil-0.1.0/PKG-INFO

@@ -0,0 +1,242 @@
+Metadata-Version: 2.4
+Name: office-stencil
+Version: 0.1.0
+Summary: A reusable Office document template render engine for DOCX, XLSX, and PPTX.
+Author: Bin Zhang
+License-Expression: MIT
+License-File: LICENSE
+Keywords: documents,docx,office,pptx,stencil,templates,xlsx
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: docxtpl>=0.16.8
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: lxml>=5.0.0
+Requires-Dist: openpyxl>=3.1.0
+Requires-Dist: typer>=0.12.0
+Provides-Extra: api
+Requires-Dist: fastapi>=0.115.0; extra == 'api'
+Requires-Dist: uvicorn[standard]>=0.30.0; extra == 'api'
+Provides-Extra: workers
+Requires-Dist: celery>=5.4.0; extra == 'workers'
+Requires-Dist: redis>=5.0.0; extra == 'workers'
+Requires-Dist: rq>=2.0.0; extra == 'workers'
+Description-Content-Type: text/markdown
+
+# Stencil
+
+Stencil is a Python render engine for reusable Office document templates.
+
+It is designed for workflows where a `.docx`, `.xlsx`, or `.pptx` template contains placeholders, loops, and conditionals, and application data fills the template to produce a finished Office document or PDF.
+
+```bash
+stencil render invoice.docx data.json --output invoice.pdf
+```
+
+The project starts with DOCX because it is the fastest path to a useful internal tool. XLSX and PPTX are planned as separate format engines behind the same public API.
+
+## Status
+
+Pre-alpha DOCX MVP.
+
+What exists now:
+
+- `uv`-compatible Python package metadata
+- Python `>=3.12`
+- `stencil` import package
+- `render()` API for DOCX templates
+- `stencil render` CLI command for JSON data
+- DOCX-first roadmap in local ignored docs
+
+What does not exist yet:
+
+- Stable public API
+- PDF conversion worker
+- XLSX rendering
+- PPTX rendering
+
+## Naming
+
+The product, import package, and CLI command are named `stencil`.
+
+The PyPI distribution name is currently `office-stencil` because `stencil` is already taken on PyPI by an old package.
+
+```toml
+[project]
+name = "office-stencil"
+
+[project.scripts]
+stencil = "stencil.cli:app"
+```
+
+## API
+
+```python
+from stencil import render
+
+document = render(
+    template_path="invoice.docx",
+    data={
+        "customer": "Acme",
+        "line_items": [
+            {"description": "Implementation", "amount": 1200},
+        ],
+    },
+    output_format="docx",
+)
+```
+
+Phase 1 supports DOCX input and DOCX output only. The exact API may change while the project is pre-alpha.
+
+## CLI
+
+```bash
+stencil render invoice.docx data.json --output invoice.docx
+```
+
+The CLI reads a top-level JSON object from the data file and writes the rendered document bytes to the output path.
+
+PDF output is planned for a later phase.
+
+## Example
+
+See [examples/](examples/) for a runnable DOCX example with:
+
+- `examples/templates/invoice.docx`
+- `examples/data/invoice.json`
+- `examples/templates/styled-status-report.docx`
+- `examples/data/status-report.json`
+
+```bash
+uv sync --dev
+uv run stencil render examples/templates/invoice.docx examples/data/invoice.json --output examples/out/invoice.docx
+uv run stencil render examples/templates/styled-status-report.docx examples/data/status-report.json --output examples/out/styled-status-report.docx
+```
+
+## Roadmap
+
+1. Foundation and proof of shape
+2. DOCX MVP
+3. PDF conversion and reliability
+4. Internal package polish
+5. XLSX engine
+6. PPTX engine
+7. Optional service layer and operations
+
+The detailed local roadmap lives in `docs/`, which is intentionally ignored by git because it is personal planning material.
+
+## Dependencies
+
+Runtime dependencies:
+
+- `jinja2`: template expressions, conditionals, and loops
+- `docxtpl`: DOCX rendering for the first production milestone
+- `lxml`: Office XML parsing and manipulation
+- `openpyxl`: XLSX workbook inspection and future spreadsheet support
+- `typer`: CLI framework
+
+Optional API dependencies:
+
+- `fastapi`: future HTTP service layer
+- `uvicorn[standard]`: ASGI server for the optional API
+
+Optional worker dependencies:
+
+- `rq`: lightweight Redis-backed queue option
+- `celery`: larger distributed worker option
+- `redis`: queue/backend client
+
+Development dependencies:
+
+- `pytest`: test runner
+- `pytest-cov`: coverage reporting
+- `ruff`: linting and import sorting
+- `mypy`: static type checking
+
+External system dependency:
+
+- LibreOffice / `soffice`: planned conversion engine for PDF output
+
+## Local Development
+
+This repo uses `uv`, but dependencies have not been installed yet.
+
+Install dependencies when ready:
+
+```bash
+uv sync --dev
+```
+
+Run tests:
+
+```bash
+uv run pytest
+```
+
+Run linting:
+
+```bash
+uv run ruff check .
+```
+
+Run type checking:
+
+```bash
+uv run mypy
+```
+
+## Publishing
+
+The repo includes a GitHub Actions workflow at `.github/workflows/publish.yml`.
+
+It publishes to PyPI when changes land on `main`:
+
+1. Check out the repo.
+2. Install `uv`.
+3. Set up Python 3.12.
+4. Install dependencies with `uv sync --dev`.
+5. Run tests with `uv run pytest`.
+6. Run linting with `uv run ruff check .`.
+7. Build the package with `uv build`.
+8. Publish with the `PYPI_API_TOKEN` GitHub Actions secret.
+
+One-time PyPI token setup:
+
+- Create or use the PyPI project named `office-stencil`.
+- Create a PyPI API token. Prefer a project-scoped token for `office-stencil` after the first release exists.
+- Add the token to GitHub as an Actions secret named `PYPI_API_TOKEN`.
+- The publish workflow uses `user: __token__` and `password: ${{ secrets.PYPI_API_TOKEN }}`.
+
+PyPI requires every upload to have a new version. Before merging a feature branch into `main`, update the `version` in `pyproject.toml`.
+
+## Dependabot
+
+The repo includes `.github/dependabot.yml`.
+
+Dependabot checks weekly for:
+
+- `uv` dependency updates from `pyproject.toml`
+- GitHub Actions updates from `.github/workflows/`
+
+Dependabot will open pull requests. Those PRs should go through the same CI and branch-protection rules as feature branches.
+
+## Design Notes
+
+Office files are zipped XML packages, but each format has different failure modes.
+
+- DOCX can split template tags across Word text runs.
+- XLSX often stores text in shared strings, so naive replacement can mutate unrelated cells.
+- PPTX repeated slides require cloning slide XML, relationships, presentation ordering, and content type entries.
+- PDF conversion through LibreOffice needs timeouts, retries, cleanup, and worker isolation.
+
+Stencil should stay milestone-driven: ship a reliable DOCX engine first, then use real needs to decide when XLSX, PPTX, and service infrastructure are worth the extra complexity.
+
+## License
+
+MIT. See [LICENSE](LICENSE).