synthpopcan 0.1.0__tar.gz

synthpopcan-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  python:
+    name: Python
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up 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 --group dev --group docs
+
+      - name: Lint Python
+        run: uv run ruff check src tests scripts
+
+      - name: Run tests
+        run: uv run pytest
+
+      - name: Build documentation
+        run: uv run sphinx-build -W -b html docs docs/_build/html
+
+  web:
+    name: Web assets
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "24"
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Check web assets
+        run: npm run check:web

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

@@ -0,0 +1,39 @@
+name: Publish Python package
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/*
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/synthpopcan
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

synthpopcan-0.1.0/.gitignore

@@ -0,0 +1,38 @@
+# Local data and reference corpora copied from Downloads.
+/data/
+/references/
+
+# Python/cache/build artifacts.
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+dist/
+build/
+*.egg-info/
+/docs/_build/
+
+# JavaScript dev tooling artifacts.
+node_modules/
+.npm/
+
+# Virtual environments and local environment files.
+.venv/
+venv/
+.env
+.env.*
+
+# OS/editor noise.
+.DS_Store
+.idea/
+.vscode/*
+!.vscode/
+!.vscode/settings.json
+
+# Future run outputs and notebooks checkpoints.
+/runs/
+/outputs/
+.ipynb_checkpoints/

synthpopcan-0.1.0/.readthedocs.yaml

@@ -0,0 +1,19 @@
+# Read the Docs configuration file for SynthPopCan.
+# See https://docs.readthedocs.com/platform/stable/config-file/v2.html
+
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

synthpopcan-0.1.0/.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+  "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
+  "python.analysis.extraPaths": ["${workspaceFolder}/src"],
+  "python.analysis.diagnosticMode": "workspace",
+  "python.analysis.typeCheckingMode": "off",
+  "python.analysis.exclude": [
+    "**/.venv",
+    "**/__pycache__",
+    "**/.pytest_cache",
+    "**/.ruff_cache",
+    "docs/_build",
+    "node_modules",
+    "dist"
+  ],
+  "python.terminal.activateEnvironment": true
+}

synthpopcan-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing
+
+SynthPopCan is early-stage research software. Keep changes small, reviewable,
+and grounded in the existing code and documentation structure.
+
+## Development Setup
+
+Install the Python and documentation dependencies:
+
+```bash
+uv sync --group dev --group docs
+```
+
+Install web tooling:
+
+```bash
+npm ci
+```
+
+Run the normal checks before opening a pull request:
+
+```bash
+uv run ruff check src tests scripts
+uv run pytest
+uv run sphinx-build -W -b html docs docs/_build/html
+npm run check:web
+```
+
+## Data And Model Safety
+
+Do not commit raw Census microdata, downloaded bulk data caches, generated CSV
+outputs, private research datasets, or local reference corpora. Keep those files
+under ignored paths such as `data/raw`, `data/private`, `references`, `runs`, or
+`outputs`.
+
+Reviewed model packages may be published only when they are explicitly intended
+for distribution and carry provenance and disclosure-risk metadata. Large
+packages should be uploaded as GitHub Release assets and listed in the model
+registry, not bundled into the normal Python package.
+
+Before contributing a model artifact:
+
+- verify it contains no raw source rows or source identifiers;
+- inspect its provenance and redistribution notes;
+- run the relevant SynthPopCan audit/release workflow;
+- confirm large files are distributed as release assets with checksums and
+  fetched on demand by `synthpopcan models fetch`.
+
+## Documentation
+
+User-facing behavior should be documented where readers will look for it:
+
+- `README.md` for project orientation and public-repo expectations;
+- `docs/` for workflow and API documentation;
+- `PLANS.md` for open roadmap items;
+- `NOTES.md` for research notes.
+
+Avoid putting long walkthroughs in the README when they belong in Sphinx docs.

synthpopcan-0.1.0/LICENSE

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