Merge pull request #75 from PolicyEngine/type-hints

Move to Pythonic functions with strict models

.github/CONTRIBUTING.md

@@ -1,3 +1,14 @@
 ## Updating the versioning
 
-Please add to `changelog.yaml` and then run `make changelog` before committing the results ONCE in this PR.
+Please add to `changelog_entry.yaml` an entry in the format:
+
+```yaml
+- bump: minor
+  changes:
+    added:
+    - New feature.
+    fixed:
+    - Bug fix.
+    changed:
+    - Change.
+```

.github/workflows/any_changes.yaml

@@ -0,0 +1,26 @@
+# Workflow that runs on code changes to a pull request.
+
+name: Any changes
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  docs:
+      name: Test documentation builds
+      runs-on: ubuntu-latest
+      steps:
+        - name: Checkout repo
+          uses: actions/checkout@v2
+
+        - name: Set up Python
+          uses: actions/setup-python@v2
+          with:
+            python-version: '3.10'
+
+        - name: Install package
+          run: make install
+
+        - name: Test documentation builds
+          run: make documentation

.github/workflows/code_changes.yaml

@@ -0,0 +1,41 @@
+# Workflow that runs on code changes to a pull request.
+
+name: Code changes
+on:
+  pull_request:
+    branches:
+      - main
+
+    paths:
+      - policyengine/**
+      - tests/**
+
+jobs:
+  Lint:
+    runs-on: ubuntu-latest
+    steps:
+        - uses: actions/checkout@v4
+        - name: Check formatting
+          uses: "lgeiger/black-action@master"
+          with:
+              args: ". -l 79 --check"
+  Test:
+      runs-on: ubuntu-latest
+      steps:
+          - name: Checkout repo
+            uses: actions/checkout@v2
+          - name: Install uv
+            uses: astral-sh/setup-uv@v5
+
+          - name: Set up Python
+            uses: actions/setup-python@v2
+            with:
+                python-version: '3.10'
+
+          - name: Install package
+            run: uv pip install .[dev] --system
+
+          - name: Run tests
+            run: make test
+            env:
+              HUGGING_FACE_TOKEN: ${{ secrets.HUGGING_FACE_TOKEN }}

.github/workflows/publish.yaml

@@ -0,0 +1,29 @@
+name: Push
+on:
+  push:
+    branches: [ main ]
+    paths:
+        - pyproject.toml
+
+jobs:
+  Publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Publish a git tag
+        run: ".github/publish-git-tag.sh || true"
+      - name: Install package
+        run: make install
+      - name: Build package
+        run: make
+      - name: Publish a Python distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI }}
+          skip-existing: true

.github/workflows/versioning.yaml

@@ -0,0 +1,34 @@
+# Workflow that runs on versioning metadata updates.
+
+name: Versioning updates
+on:
+  push:
+      branches:
+          - main
+
+      paths:
+          - changelog_entry.yaml
+
+jobs:
+    Versioning:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout repo
+              uses: actions/checkout@v4
+              with:
+                repository: ${{ github.event.pull_request.head.repo.full_name }}
+                ref: ${{ github.event.pull_request.head.ref }}
+                token: ${{ secrets.POLICYENGINE_GITHUB }}
+            - name: Setup Python
+              uses: actions/setup-python@v5
+              with:
+                python-version: 3.12
+            - name: Build changelog
+              run: pip install yaml-changelog && make changelog
+            - name: Preview changelog update
+              run: ".github/get-changelog-diff.sh"
+            - name: Update changelog
+              uses: EndBug/add-and-commit@v9
+              with:
+                add: "."
+                message: Update package version

.gitignore

@@ -160,3 +160,5 @@ cython_debug/
 #.idea/
 
 *.ipynb
+
+!docs/**/*.ipynb

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.5.0] - 2025-01-24 00:08:26
+
+### Changed
+
+- Moved to strong typing.
+
 ## [2.4.1] - 2025-01-09 10:52:28
 
 ### Fixed
@@ -70,6 +76,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
+[2.5.0]: https://github.com/PolicyEngine/policyengine.py/compare/2.4.1...2.5.0
 [2.4.1]: https://github.com/PolicyEngine/policyengine.py/compare/2.4.0...2.4.1
 [2.4.0]: https://github.com/PolicyEngine/policyengine.py/compare/2.3.0...2.4.0
 [2.3.0]: https://github.com/PolicyEngine/policyengine.py/compare/2.2.2...2.3.0

Makefile

@@ -19,3 +19,6 @@ changelog:
 
 build:
 	python -m build
+
+test:
+	pytest tests

changelog.yaml

@@ -52,3 +52,8 @@
     fixed:
     - Subsetting bug with time periods.
   date: 2025-01-09 10:52:28
+- bump: minor
+  changes:
+    changed:
+    - Moved to strong typing.
+  date: 2025-01-24 00:08:26

docs/_config.yml

@@ -5,7 +5,7 @@ copyright: "2025"
 logo: logo.png
 
 execute:
-  execute_notebooks: force
+  execute_notebooks: cache
   stderr_output: error
   timeout: 600
 
@@ -14,6 +14,8 @@ repository:
   branch: master
   path_to_book: docs
 
+title: Python documentation
+
 sphinx:
   config:
     html_js_files:
@@ -24,3 +26,6 @@ sphinx:
       - style.css
   extra_extensions:
     - "sphinx.ext.autodoc"
+    - "sphinxcontrib.autodoc_pydantic"
+
+only_build_toc_files: true

docs/_static/style.css

@@ -1,9 +1,15 @@
 @import url('https://fonts.googleapis.com/css2?family=Roboto+Serif:[email protected]&family=Roboto:wght@300&display=swap');
 
-h1, h2, h3, h4, h5, h6 {
+
+h1, h2, h3, h4, h5, p.rubric {
     font-family: "Roboto";
+    font-weight: 200;
 }
 
 body {
     font-family: "Roboto Serif";
-}
+}
+
+.sidebar-brand-text {
+    text-align: left;
+}

docs/_toc.yml

@@ -1,10 +1,6 @@
 format: jb-book
 root: index
 parts:
-  - caption: Maintenance
-    chapters:
-    - file: maintaining
   - caption: Reference
     chapters:
     - file: reference/simulation
-    - file: reference/calculate