policyengine 0.1.1__tar.gz

policyengine-0.1.1/.github/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+## Updating the versioning
+
+Please add to `changelog_entry.yaml` an entry in the format:
+
+```yaml
+- bump: minor
+  changes:
+    added:
+    - New feature.
+    fixed:
+    - Bug fix.
+    changed:
+    - Change.
+```

policyengine-0.1.1/.github/changelog_template.md

@@ -0,0 +1,8 @@
+# Changelog
+
+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).
+
+{{changelog}}

policyengine-0.1.1/.github/fetch_version.py

@@ -0,0 +1,13 @@
+def fetch_version():
+    try:
+        import importlib
+
+        return importlib.import_module("policyengine").__version__
+        return version
+    except Exception as e:
+        print(f"Error fetching version: {e}")
+        return None
+
+
+if __name__ == "__main__":
+    print(fetch_version())

policyengine-0.1.1/.github/get-changelog-diff.sh

@@ -0,0 +1,2 @@
+last_tagged_commit=`git describe --tags --abbrev=0 --first-parent`
+git --no-pager diff $last_tagged_commit -- CHANGELOG.md

policyengine-0.1.1/.github/has-functional-changes.sh

@@ -0,0 +1,12 @@
+#! /usr/bin/env bash
+
+IGNORE_DIFF_ON="README.md CONTRIBUTING.md Makefile docs/* .gitignore LICENSE* .github/* data/*"
+
+last_tagged_commit=`git describe --tags --abbrev=0 --first-parent`  # --first-parent ensures we don't follow tags not published in master through an unlikely intermediary merge commit
+
+if git diff-index --name-only --exit-code $last_tagged_commit -- . `echo " $IGNORE_DIFF_ON" | sed 's/ / :(exclude)/g'`  # Check if any file that has not be listed in IGNORE_DIFF_ON has changed since the last tag was published.
+then
+  echo "No functional changes detected."
+  exit 1
+else echo "The functional files above were changed."
+fi

policyengine-0.1.1/.github/is-version-number-acceptable.sh

@@ -0,0 +1,33 @@
+#! /usr/bin/env bash
+
+if [[ ${GITHUB_REF#refs/heads/} == master ]]
+then
+    echo "No need for a version check on master."
+    exit 0
+fi
+
+if ! $(dirname "$BASH_SOURCE")/has-functional-changes.sh
+then
+    echo "No need for a version update."
+    exit 0
+fi
+
+current_version=`python .github/fetch_version.py`
+
+if git rev-parse --verify --quiet $current_version
+then
+    echo "Version $current_version already exists in commit:"
+    git --no-pager log -1 $current_version
+    echo
+    echo "Update the version number in setup.py before merging this branch into master."
+    echo "Look at the CONTRIBUTING.md file to learn how the version number should be updated."
+    exit 1
+fi
+
+if ! $(dirname "$BASH_SOURCE")/has-functional-changes.sh | grep --quiet CHANGELOG.md
+then
+    echo "CHANGELOG.md has not been modified, while functional changes were made."
+    echo "Explain what you changed before merging this branch into master."
+    echo "Look at the CONTRIBUTING.md file to learn how to write the changelog."
+    exit 2
+fi

policyengine-0.1.1/.github/publish-git-tag.sh

@@ -0,0 +1,4 @@
+#! /usr/bin/env bash
+
+git tag `python .github/fetch_version.py`  # create a new tag
+git push --tags || true  # update the repository version

policyengine-0.1.1/.github/workflows/any_changes.yaml

@@ -0,0 +1,40 @@
+# 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: Install uv
+          uses: astral-sh/setup-uv@v5
+
+        - name: Set up Python
+          uses: actions/setup-python@v2
+          with:
+            python-version: '3.11'
+              
+        - name: Install package
+          run: uv pip install .[dev] --system
+        
+        - name: Test documentation builds
+          run: make documentation
+          env:
+            HUGGING_FACE_TOKEN: ${{ secrets.HUGGING_FACE_TOKEN }}
+
+        - name: Check documentation build
+          run: |
+            for notebook in $(find docs/_build/jupyter_execute -name "*.ipynb"); do
+              if grep -q '"output_type": "error"' "$notebook"; then
+                echo "Error found in $notebook"
+                cat "$notebook"
+                exit 1
+              fi
+            done

policyengine-0.1.1/.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.11'
+              
+          - name: Install package
+            run: uv pip install .[dev] --system
+          
+          - name: Run tests
+            run: make test
+            env:
+              HUGGING_FACE_TOKEN: ${{ secrets.HUGGING_FACE_TOKEN }}

policyengine-0.1.1/.github/workflows/publish_documentation.yaml

@@ -0,0 +1,33 @@
+name: Publish documentation
+on:
+  push:
+    branches: [ main ]
+    paths:
+        - docs/** # Only run workflow when documentation changes
+
+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 documentation
+        run: make documentation
+        env:
+          HUGGING_FACE_TOKEN: ${{ secrets.HUGGING_FACE_TOKEN }}
+      
+      - name: Deploy documentation
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: docs/_build/html # The folder the action should deploy.

policyengine-0.1.1/.github/workflows/publish_package.yaml

@@ -0,0 +1,47 @@
+name: Publish package
+on:
+  push:
+    branches: [ main ]
+    paths:
+        - pyproject.toml
+
+jobs:
+  Publish:
+    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.11'
+      - name: Publish a git tag
+        run: ".github/publish-git-tag.sh || true"
+      - name: Install package
+        run: make install
+      - name: Build package
+        run: make
+      - name: Remove .whl files
+        run: rm dist/*.whl
+      - name: Publish a Python distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI }}
+          skip-existing: true
+          verbose: true
+        
+      - name: Test documentation builds
+        run: make documentation
+        env:
+          HUGGING_FACE_TOKEN: ${{ secrets.HUGGING_FACE_TOKEN }}
+      
+      - name: Deploy documentation
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: docs/_build/html # The folder the action should deploy.

policyengine-0.1.1/.github/workflows/versioning.yaml

@@ -0,0 +1,37 @@
+# Workflow that runs on versioning metadata updates.
+
+name: Versioning updates
+on:
+  push:
+      branches:
+        - main
+
+      paths:
+        - changelog_entry.yaml
+        - "!pyproject.toml"
+
+jobs:
+    Versioning:
+        runs-on: ubuntu-latest
+        if: |
+          (!(github.event.head_commit.message == 'Update package version'))
+        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

policyengine-0.1.1/.gitignore

@@ -0,0 +1,164 @@
+# 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/
+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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# 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
+.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/
+
+*.ipynb
+
+!docs/**/*.ipynb

policyengine-0.1.1/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+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).
+
+## [0.1.1] - 2025-02-21 14:02:22
+
+### Fixed
+
+- Dependency for `pkg_resources`.
+
+## [0.1.0] - 2024-11-30 00:00:00
+
+### Added
+
+- Initial version of package.
+
+
+
+[0.1.1]: https://github.com/PolicyEngine/policyengine.py/compare/0.1.0...0.1.1