dp_wizard_templates 0.1.0__tar.gz

dp_wizard_templates-0.1.0/.coveragerc

@@ -0,0 +1,17 @@
+[run]
+# All files under source are checked, even if not otherwise referenced.
+source = .
+
+# More strict: Check transitions between lines, not just individual lines.
+# TODO: branch = True
+
+omit =
+  README_examples/*
+
+
+[report]
+show_missing = True
+skip_covered = True
+fail_under = 100
+exclude_also =
+  template

dp_wizard_templates-0.1.0/.flake8

@@ -0,0 +1,14 @@
+[flake8]
+exclude = .git,.venv,.venv-*,__pycache__
+
+# Config recommended by black:
+# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#bugbear
+max-line-length = 80
+extend-select = B950
+extend-ignore = E203,E501,E701
+
+per-file-ignores =
+    # Ignore undefined names in templates.
+    README_examples/*.py:F821,F401,E302
+    # Ignore mid-file imports: These are better for exaplanation.
+    README_test.py:E402

dp_wizard_templates-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,40 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        python-version:
+          - '3.10'
+          - '3.13'
+        requirements-file:
+          - 'requirements-dev.txt' # pinned, for predictability
+          - 'requirements-dev.in' # un-pinned, so we catch problems early
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install flit
+        run: pip install flit
+
+      - name: Install package
+        run: flit install
+
+      - name: Install dev dependencies
+        run: pip install -r ${{ matrix.requirements-file }}
+
+      - name: Test
+        run: scripts/ci.sh

dp_wizard_templates-0.1.0/.gitignore

@@ -0,0 +1,209 @@
+.DS_Store
+
+# 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
+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
+
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

dp_wizard_templates-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+  # Using this mirror lets us use mypyc-compiled black, which is about 2x faster
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 24.8.0
+    hooks:
+      - id: black
+        # It is recommended to specify the latest version of Python
+        # supported by your project here, or alternatively use
+        # pre-commit's default_language_version, see
+        # https://pre-commit.com/#top_level-default_language_version
+        language_version: python3.11

dp_wizard_templates-0.1.0/.pytest.ini

@@ -0,0 +1,14 @@
+[pytest]
+
+
+
+filterwarnings =
+	# Treat warnings as errors,
+	error
+	# except for https://github.com/jupyter/jupyter_core/issues/398
+	ignore:.*Jupyter is migrating.*:DeprecationWarning
+
+addopts = --doctest-glob '*.md' --doctest-modules
+
+# If an xfail starts passing unexpectedly, that should count as a failure:
+xfail_strict=true

dp_wizard_templates-0.1.0/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.1.0
+
+Initial release

dp_wizard_templates-0.1.0/LICENSE

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

dp_wizard_templates-0.1.0/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: dp_wizard_templates
+Version: 0.1.0
+Summary: Code templating tools
+Author-email: The OpenDP Project <info@opendp.org>
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: black
+Requires-Dist: ipykernel
+Requires-Dist: jupyter-client
+Requires-Dist: jupytext
+Requires-Dist: nbconvert
+Project-URL: Home, https://github.com/opendp/dp-wizard-templates
+
+# DP Wizard Templates
+
+[![pypi](https://img.shields.io/pypi/v/dp_wizard_templates)](https://pypi.org/project/dp_wizard_templates/)
+
+DP Wizard Templates lets you use syntactically valid Python code as a template.
+Templates can be filled and composed to generate entire notebooks.
+
+[`README_test.py`](https://github.com/opendp/dp-wizard-templates/blob/main/README_test.py) provides an example of use,
+and an example [output notebook](https://github.com/opendp/dp-wizard-templates/blob/main/README_examples/hello-world.ipynb)
+is also available.
+
+DP Wizard Templates was developed for [DP Wizard](https://github.com/opendp/dp-wizard),
+and that codebase remains a good place to look for further examples.
+
+
+## Development
+
+### Getting Started
+
+On MacOS:
+```shell
+$ git clone https://github.com/opendp/dp-wizard-templates.git
+$ cd dp-wizard-templates
+$ brew install python@3.10
+$ python3.10 -m venv .venv
+$ source .venv/bin/activate
+```
+
+You can now install dependencies:
+```shell
+$ pip install -r requirements-dev.txt
+$ pre-commit install
+$ flit install
+```
+
+Tests should pass, and code coverage should be complete (except blocks we explicitly ignore):
+```shell
+$ scripts/ci.sh
+```
+
+### Release
+
+- Make sure you're up to date, and have the git-ignored credentials file `.pypirc`.
+- Make one last feature branch with the new version number in the name:
+  - Run `scripts/changelog.py` to update the `CHANGELOG.md`.
+  - Review the updates and pull a couple highlights to the top.
+  - Bump `dp_wizard/VERSION`, and add the new number at the top of the `CHANGELOG.md`.
+  - Commit your changes, make a PR, and merge this branch to main.
+- Update `main` with the latest changes: `git checkout main; git pull`
+- Publish: `flit publish --pypirc .pypirc`
+

dp_wizard_templates-0.1.0/README.md

@@ -0,0 +1,50 @@
+# DP Wizard Templates
+
+[![pypi](https://img.shields.io/pypi/v/dp_wizard_templates)](https://pypi.org/project/dp_wizard_templates/)
+
+DP Wizard Templates lets you use syntactically valid Python code as a template.
+Templates can be filled and composed to generate entire notebooks.
+
+[`README_test.py`](https://github.com/opendp/dp-wizard-templates/blob/main/README_test.py) provides an example of use,
+and an example [output notebook](https://github.com/opendp/dp-wizard-templates/blob/main/README_examples/hello-world.ipynb)
+is also available.
+
+DP Wizard Templates was developed for [DP Wizard](https://github.com/opendp/dp-wizard),
+and that codebase remains a good place to look for further examples.
+
+
+## Development
+
+### Getting Started
+
+On MacOS:
+```shell
+$ git clone https://github.com/opendp/dp-wizard-templates.git
+$ cd dp-wizard-templates
+$ brew install python@3.10
+$ python3.10 -m venv .venv
+$ source .venv/bin/activate
+```
+
+You can now install dependencies:
+```shell
+$ pip install -r requirements-dev.txt
+$ pre-commit install
+$ flit install
+```
+
+Tests should pass, and code coverage should be complete (except blocks we explicitly ignore):
+```shell
+$ scripts/ci.sh
+```
+
+### Release
+
+- Make sure you're up to date, and have the git-ignored credentials file `.pypirc`.
+- Make one last feature branch with the new version number in the name:
+  - Run `scripts/changelog.py` to update the `CHANGELOG.md`.
+  - Review the updates and pull a couple highlights to the top.
+  - Bump `dp_wizard/VERSION`, and add the new number at the top of the `CHANGELOG.md`.
+  - Commit your changes, make a PR, and merge this branch to main.
+- Update `main` with the latest changes: `git checkout main; git pull`
+- Publish: `flit publish --pypirc .pypirc`

dp_wizard_templates-0.1.0/README_examples/_block_demo.py

@@ -0,0 +1,5 @@
+def FUNCTION_NAME(PARAMS):
+    """
+    This demonstrates how larger blocks of code can be built compositionally.
+    """
+    INNER_BLOCK