nullpol 0.1.1__tar.gz → 0.2.0__tar.gz

nullpol-0.2.0/.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,56 @@
+---
+name: 🐛 Bug Report
+about: Create a report to help us improve
+title: '[BUG]: '
+labels: bug
+assignees: ''
+---
+
+## 📝 Description
+
+A clear and concise description of what the bug is.
+
+## 🚀 Reproduction Steps
+
+Steps to reproduce the behavior:
+
+1. '...'
+2. '...'
+3. '...'
+
+## 💻 Minimal Reproducible Example
+
+Please provide a short snippet of Python code that demonstrates the issue. Use
+code blocks for readability:
+
+```python
+# Your code here
+```
+
+## 📋 Expected Behavior
+
+A clear and concise description of what you expected to happen.
+
+## 💥 Actual Behavior / Traceback
+
+If applicable, add the Python error traceback here **after redacting secrets**
+(API keys, tokens, credentials, private URLs/paths, personal data). If this is a
+potential security vulnerability, do **not** post it publicly; use the Security
+reporting channel instead.
+
+```text
+Traceback (most recent call last):
+  ...
+
+```
+
+## 🛠 Environment Information
+
+- **Python Version:** (e.g., 3.13)
+- **Package Version:** (e.g., 1.2.3)
+- **Operating System:** (e.g., Windows 11, Ubuntu 22.04, macOS)
+- **Relevant Dependencies:** (e.g., numpy, pandas version if applicable)
+
+## 📎 Additional Context
+
+Add any other context about the problem here (e.g., screenshots, logs).

nullpol-0.2.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+    - name: GitHub Community Support
+      url: https://github.com/isaac-cf-wong/nullpol/discussions
+      about: Please ask and answer questions here.

nullpol-0.2.0/.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,47 @@
+---
+name: ✨ Feature Request
+about: Suggest an idea or improvement for this package
+title: '[FEATURE]: '
+labels: enhancement
+assignees: ''
+---
+
+## 🎯 Problem Statement
+
+Is your feature request related to a problem? Please describe.
+
+> _Ex: "I'm always frustrated when I have to manually loop over X to achieve
+> Y..."_
+
+## 💡 Proposed Solution
+
+A clear and concise description of what you want to happen. Describe the new
+functionality or the change to existing behavior.
+
+## 💻 Proposed API / Usage Example
+
+If applicable, show how you would imagine the Python code looking with this new
+feature:
+
+```python
+import nullpol
+
+# How you'd like to use the new feature
+result = nullpol.new_function(param="example")
+
+```
+
+## 🌈 Use Case & Benefits
+
+Why is this feature important to you and other users? How does it improve the
+package?
+
+## 🔄 Alternatives Considered
+
+A clear and concise description of any alternative solutions or workarounds
+you've considered (e.g., using a different library or a custom wrapper).
+
+## ⚠️ Additional Context
+
+Add any other context, screenshots, or links to similar implementations in other
+libraries here.

nullpol-0.2.0/.github/pull_request_template.md

@@ -0,0 +1,40 @@
+---
+name: 🚀 Pull Request
+about: Submit your changes for review
+---
+
+## 📝 Summary
+
+Briefly describe the changes introduced by this PR. Mention any related issues
+using keywords (e.g., `Closes #123`).
+
+## ✨ Type of Change
+
+- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
+- [ ] ✨ New feature (non-breaking change which adds functionality)
+- [ ] 💥 Breaking change (fix or feature that would cause existing functionality
+      to not work as expected)
+- [ ] 📝 Documentation update
+- [ ] 🎨 Refactoring (no functional changes, no API changes)
+
+## 🧪 How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes.
+
+- [ ] **Unit Tests:** `uv run pytest tests/test_feature.py`
+- [ ] **Manual Test:** (Describe steps)
+
+## 🏗️ Checklist
+
+- [ ] My code follows the style guidelines of this project (PEP 8).
+- [ ] I have performed a self-review of my own code.
+- [ ] I have commented my code, particularly in hard-to-understand areas.
+- [ ] I have made corresponding changes to the documentation.
+- [ ] My changes generate no new warnings.
+- [ ] I have added tests that prove my fix is effective or that my feature
+      works.
+
+## 📷 Screenshots (if applicable)
+
+If this is a UI change or produces a specific output/graph, add screenshots
+here.

nullpol-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+    workflow_dispatch:
+    workflow_call:
+
+jobs:
+    test:
+        strategy:
+            matrix:
+                python-version: ['3.12', '3.13', '3.14']
+                os: [ubuntu-latest, macos-latest]
+        runs-on: ${{ matrix.os }}
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+              with:
+                  python-version: ${{ matrix.python-version }}
+                  enable-cache: 'true'
+
+            - name: Install dependencies
+              run: uv sync --group dev --frozen
+
+            - name: Run tests with pytest
+              run: uv run --frozen pytest
+
+            - name: Upload coverage to Codecov
+              if: ${{ !cancelled() }}
+              uses: codecov/codecov-action@0fb7174895f61a3b6b78fc075e0cd60383518dac # v5
+              with:
+                  token: ${{ secrets.CODECOV_TOKEN }}

nullpol-0.2.0/.github/workflows/codeql.yml

@@ -0,0 +1,29 @@
+name: CodeQL
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+    workflow_dispatch:
+    workflow_call:
+
+permissions:
+    security-events: write
+
+jobs:
+    codeql:
+        name: codeql
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+
+            - name: Initialize CodeQL
+              uses: github/codeql-action/init@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4
+              with:
+                  languages: python
+
+            - name: Autobuild
+              uses: github/codeql-action/autobuild@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4
+
+            - name: Perform CodeQL Analysis
+              uses: github/codeql-action/analyze@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4

nullpol-0.2.0/.github/workflows/documentation.yml

@@ -0,0 +1,42 @@
+name: Documentation
+
+on:
+    push:
+        branches: [main]
+    workflow_dispatch:
+
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+concurrency:
+    group: pages
+    cancel-in-progress: false
+
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+              with:
+                  python-version: '3.13'
+                  enable-cache: 'true'
+
+            - name: Install dependencies
+              run: uv sync --group docs --frozen
+
+            - run: uv run --frozen zensical build
+
+            - uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4
+              with:
+                  path: site
+
+            - id: deployment
+              uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4

nullpol-0.2.0/.github/workflows/draft-release.yml

@@ -0,0 +1,50 @@
+name: Draft Release
+
+on:
+    push:
+        branches: [main]
+
+permissions:
+    contents: write
+    pull-requests: read
+
+concurrency:
+    group: draft-release
+    cancel-in-progress: true
+
+jobs:
+    draft-release:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+              with:
+                  fetch-depth: 0
+
+            - name: Generate changelog
+              id: changelog
+              uses: orhun/git-cliff-action@f50e11560dce63f7c33227798f90b924471a88b5 # v4.8.0
+              with:
+                  config: cliff.toml
+                  args: --unreleased --verbose
+              env:
+                  OUTPUT: CHANGELOG.md
+
+            - name: Delete existing draft release
+              continue-on-error: true
+              run: |
+                  gh release delete next-release --yes
+              env:
+                  GH_TOKEN: ${{ github.token }}
+
+            - name: Create or Update Draft Release
+              uses: softprops/action-gh-release@3bb12739c298aeb8a4eeaf626c5b8d85266b0e65 # v2
+              with:
+                  tag_name: next-release
+                  name: 'Next Release (Draft)'
+                  body: |
+                      ${{ steps.changelog.outputs.content }}
+
+                      ---
+                      *This is an automatically generated draft release.*
+                  draft: true
+                  prerelease: false

nullpol-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,59 @@
+name: Publish to PyPI
+
+on:
+    workflow_dispatch:
+        inputs:
+            tag_name:
+                description: 'Tag name for the publish (e.g., v1.2.3)'
+                required: true
+                type: string
+    workflow_call:
+        inputs:
+            tag_name:
+                description: 'Tag name for the publish (e.g., v1.2.3)'
+                required: true
+                type: string
+
+jobs:
+    publish:
+        runs-on: ubuntu-latest
+        environment:
+            name: pypi
+        permissions:
+            id-token: write
+            contents: read
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+              with:
+                  ref: ${{ inputs.tag_name || github.event.inputs.tag_name }}
+                  fetch-depth: 0
+
+            - name: Output build information
+              run: |
+                  echo "### Publishing Build :package:" >> $GITHUB_STEP_SUMMARY
+                  echo "- **Version tag**: ${{ inputs.tag_name || github.event.inputs.tag_name }}" >> $GITHUB_STEP_SUMMARY
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+              with:
+                  python-version: '3.13'
+                  enable-cache: 'true'
+
+            - name: Install dependencies
+              run: uv sync --group dev --frozen
+
+            - name: Build distribution
+              run: uv build
+
+            - name: Smoke test (wheel)
+              run:
+                  uv run --isolated --no-project --with dist/*.whl
+                  tests/smoke_test.py
+
+            - name: Smoke test (source distribution)
+              run:
+                  uv run --isolated --no-project --with dist/*.tar.gz
+                  tests/smoke_test.py
+
+            - name: Publish to PyPI
+              run: uv publish

nullpol-0.2.0/.github/workflows/publish_testpypi.yml

@@ -0,0 +1,76 @@
+name: Publish to TestPyPI
+
+on:
+    push:
+        branches:
+            - main
+    workflow_dispatch:
+        inputs:
+            tag_name:
+                description: 'Tag name for the publish (e.g., v1.2.3)'
+                required: false
+                type: string
+    workflow_call:
+        inputs:
+            tag_name:
+                description: 'Tag name for the publish (e.g., v1.2.3)'
+                required: false
+                type: string
+
+jobs:
+    publish:
+        runs-on: ubuntu-latest
+        environment:
+            name: testpypi
+        permissions:
+            id-token: write
+            contents: read
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+              with:
+                  ref: ${{ inputs.tag_name || github.sha }}
+                  fetch-depth: 0
+
+            - name: Output build information
+              run: |
+                  echo "### Publishing Build :package:" >> $GITHUB_STEP_SUMMARY
+                  echo "- **Version tag**: ${{ inputs.tag_name || github.sha }}" >> $GITHUB_STEP_SUMMARY
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+              with:
+                  python-version: '3.13'
+                  enable-cache: 'true'
+
+            - name: Install dependencies
+              run: uv sync --group dev --group build --frozen
+
+            - name: Set version for publishing
+              run: |
+                  if [ -n "${{ inputs.tag_name }}" ]; then
+                    # Use the tag, stripping 'v' prefix if present
+                    VERSION=$(echo "${{ inputs.tag_name }}" | sed 's/^v//')
+                  else
+                    # For untagged builds, use a dev version without local part
+                    # Get the dev version from hatch-vcs, then strip +local
+                    VERSION=$(uv run --frozen hatch version | sed 's/+.*//')
+                  fi
+
+                  # Update pyproject.toml with sed
+                  sed -i "s/dynamic = \[\"version\"\]/version = \"$VERSION\"\ndynamic = []/" pyproject.toml
+
+            - name: Build distribution
+              run: uv build
+
+            - name: Smoke test (wheel)
+              run:
+                  uv run --isolated --no-project --with dist/*.whl
+                  tests/smoke_test.py
+
+            - name: Smoke test (source distribution)
+              run:
+                  uv run --isolated --no-project --with dist/*.tar.gz
+                  tests/smoke_test.py
+
+            - name: Publish to TestPyPI
+              run: uv publish --index testpypi

nullpol-0.2.0/.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Release
+
+on:
+    workflow_dispatch:
+        inputs:
+            tag_name:
+                description: 'Tag name for the release (e.g., v1.2.3)'
+                required: true
+                type: string
+    workflow_call:
+        inputs:
+            tag_name:
+                description: 'Tag name for the release (e.g., v1.2.3)'
+                required: true
+                type: string
+
+permissions:
+    contents: write
+
+jobs:
+    release:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+              with:
+                  fetch-depth: 0
+                  ref: ${{ inputs.tag_name || github.event.inputs.tag_name }}
+
+            - name: Generate changelog
+              id: changelog
+              uses: orhun/git-cliff-action@f50e11560dce63f7c33227798f90b924471a88b5 # v4.8.0
+              with:
+                  config: cliff.toml
+                  args: --current --verbose
+              env:
+                  OUTPUT: CHANGELOG.md
+
+            - name: Delete draft release
+              continue-on-error: true
+              run: |
+                  gh release delete next-release --yes
+              env:
+                  GH_TOKEN: ${{ github.token }}
+
+            - name: Create Release
+              uses: softprops/action-gh-release@3bb12739c298aeb8a4eeaf626c5b8d85266b0e65 # v2
+              with:
+                  tag_name:
+                      ${{ inputs.tag_name || github.event.inputs.tag_name }}
+                  body: ${{ steps.changelog.outputs.content }}
+                  draft: false
+                  prerelease:
+                      ${{ contains(inputs.tag_name ||
+                      github.event.inputs.tag_name, 'alpha') ||
+                      contains(inputs.tag_name || github.event.inputs.tag_name,
+                      'beta') }}

nullpol-0.2.0/.github/workflows/scheduled-release.yml

@@ -0,0 +1,137 @@
+name: Scheduled Release
+
+on:
+    schedule:
+        - cron: '0 0 * * 2'
+    workflow_dispatch:
+
+permissions:
+    contents: write
+
+jobs:
+    check_new_commits:
+        runs-on: ubuntu-latest
+        outputs:
+            has-changes: ${{ steps.check_commits.outputs.has-changes }}
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+              with:
+                  fetch-depth: 0
+
+            - name: Check for new commits
+              id: check_commits
+              uses: isaac-cf-wong/detect-git-changes-action@a67357ee6ce349a844983224faa2d0e3dfb29c7e # v0.0.12
+              with:
+                  use-latest-tag: true
+
+    ci:
+        needs: check_new_commits
+        if: ${{ needs.check_new_commits.outputs.has-changes == 'true' }}
+        uses: ./.github/workflows/ci.yml
+
+    codeql:
+        needs: check_new_commits
+        if: ${{ needs.check_new_commits.outputs.has-changes == 'true'}}
+        uses: ./.github/workflows/codeql.yml
+        permissions:
+            security-events: write
+
+    create_tag:
+        needs: [ci, codeql]
+        runs-on: ubuntu-latest
+        outputs:
+            new_tag: ${{ steps.tag_version.outputs.new_tag }}
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+              with:
+                  fetch-depth: 0
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+              with:
+                  python-version: '3.13'
+                  enable-cache: 'true'
+
+            - name: Install dependencies
+              run: uv sync --group release --frozen
+
+            - name: Bump version and push tag
+              id: tag_version
+              run: |
+                  PREVIOUS_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "none")
+                  if [ "$PREVIOUS_TAG" = "none" ]; then
+                    NEW_TAG="v0.1.0"
+                  else
+                    NEW_TAG=$(uv run --frozen git-cliff --bumped-version --config cliff.toml 2>/dev/null)
+                  fi
+                  if ! git rev-parse "$NEW_TAG" >/dev/null 2>&1; then
+                    echo "Creating annotated tag $NEW_TAG"
+
+                    git config user.name "github-actions[bot]"
+                    git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+                    git tag -a "$NEW_TAG" -m "Release $NEW_TAG"
+                    git push origin "$NEW_TAG"
+                  else
+                    echo "Tag $NEW_TAG already exists, skipping."
+                    exit 1
+                  fi
+                  echo "new_tag=$NEW_TAG" >> $GITHUB_OUTPUT
+                  echo "previous_tag=$PREVIOUS_TAG" >> $GITHUB_OUTPUT
+
+            - name: Output tag information
+              if: ${{ steps.check_commits.outputs.has-changes == 'true' }}
+              run: |
+                  echo "### Tag Created :rocket:" >> $GITHUB_STEP_SUMMARY
+                  echo "- **New tag**: ${{ steps.tag_version.outputs.new_tag }}" >> $GITHUB_STEP_SUMMARY
+                  echo "- **Previous tag**: ${{ steps.tag_version.outputs.previous_tag }}" >> $GITHUB_STEP_SUMMARY
+                  echo "- **Changelog**: ${{ steps.tag_version.outputs.changelog }}" >> $GITHUB_STEP_SUMMARY
+
+    release:
+        needs: create_tag
+        uses: ./.github/workflows/release.yml
+        permissions:
+            contents: write
+            id-token: write
+        with:
+            tag_name: ${{ needs.create_tag.outputs.new_tag }}
+
+    publish:
+        needs: release
+        runs-on: ubuntu-latest
+        environment:
+            name: pypi
+        permissions:
+            id-token: write
+            contents: read
+        steps:
+            - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+              with:
+                  ref: ${{ needs.create_tag.outputs.new_tag }}
+                  fetch-depth: 0
+
+            - name: Output build information
+              run: |
+                  echo "### Publishing Build :package:" >> $GITHUB_STEP_SUMMARY
+                  echo "- **Version tag**: ${{ needs.create_tag.outputs.new_tag }}" >> $GITHUB_STEP_SUMMARY
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+              with:
+                  python-version: '3.13'
+
+            - name: Build distribution
+              run: uv build
+
+            - name: Smoke test (wheel)
+              run:
+                  uv run --isolated --no-project --with dist/*.whl
+                  tests/smoke_test.py
+
+            - name: Smoke test (source distribution)
+              run:
+                  uv run --isolated --no-project --with dist/*.tar.gz
+                  tests/smoke_test.py
+
+            - name: Publish
+              run: uv publish

nullpol-0.2.0/.github/workflows/semantic-pr-check.yml

@@ -0,0 +1,18 @@
+name: 'Semantic PR Check'
+
+on:
+    pull_request_target:
+        types:
+            - opened
+            - reopened
+            - edited
+            - synchronize
+
+jobs:
+    main:
+        name: Validate PR title
+        runs-on: ubuntu-latest
+        steps:
+            - uses: amannn/action-semantic-pull-request@48f256284bd46cdaab1048c3721360e808335d50 # v6.1.1
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}