tif1 0.2.0__tar.gz

tif1-0.2.0/.github/RELEASE_CHECKLIST.md

@@ -0,0 +1,131 @@
+# Release Checklist
+
+Use this checklist before creating a new release.
+
+## Pre-Release
+
+### Code Quality
+- [ ] All tests pass: `uv run pytest tests/ -v`
+- [ ] Linting passes: `uv run ruff check src/ tests/`
+- [ ] Formatting is correct: `uv run ruff format --check src/ tests/`
+- [ ] Type checking passes: `uv run ty check src/tif1`
+- [ ] Coverage meets threshold (80%): Check coverage report
+- [ ] No TODO/FIXME comments in critical paths
+- [ ] All deprecation warnings addressed
+
+### Documentation
+- [ ] README.md is up to date
+- [ ] CHANGELOG.md has entry for this version
+- [ ] API documentation is current
+- [ ] Examples work with new version
+- [ ] Migration guide (if breaking changes)
+
+### Version & Metadata
+- [ ] Version bumped in `pyproject.toml`
+- [ ] Version follows semantic versioning
+- [ ] Dependencies are up to date
+- [ ] License information is correct
+- [ ] Author/maintainer info is current
+
+### Testing
+- [ ] Unit tests pass
+- [ ] Integration tests pass
+- [ ] Property-based tests pass
+- [ ] Benchmarks show no regression
+- [ ] Manual smoke test completed
+- [ ] Tested on Python 3.10, 3.11, 3.12, 3.13, 3.14
+
+### Build & Package
+- [ ] Package builds successfully: `uv build`
+- [ ] Package contents verified: `tar -tzf dist/tif1-*.tar.gz`
+- [ ] Wheel builds correctly
+- [ ] No unnecessary files in distribution
+- [ ] Package size is reasonable
+
+## Release Process
+
+### TestPyPI (Recommended First)
+- [ ] Published to TestPyPI
+- [ ] Installed from TestPyPI successfully
+- [ ] Basic functionality tested from TestPyPI install
+- [ ] Dependencies resolve correctly
+
+### PyPI
+- [ ] Published to PyPI
+- [ ] Package visible on PyPI: https://pypi.org/project/tif1/
+- [ ] Metadata displays correctly
+- [ ] README renders properly
+- [ ] Links work (homepage, docs, issues)
+
+### Git
+- [ ] Changes committed
+- [ ] Version tag created: `v0.2.0`
+- [ ] Tag pushed to GitHub
+- [ ] Branch is clean
+
+### GitHub
+- [ ] GitHub release created
+- [ ] Release notes added
+- [ ] Changelog linked
+- [ ] Assets uploaded (if any)
+
+## Post-Release
+
+### Verification
+- [ ] Install from PyPI works: `pip install tif1`
+- [ ] Import works: `python -c "import tif1"`
+- [ ] Version correct: `python -c "import tif1; print(tif1.__version__)"`
+- [ ] Basic functionality works
+- [ ] CLI works: `tif1 --version`
+
+### Communication
+- [ ] Announcement prepared
+- [ ] Social media posts scheduled
+
+
+### Maintenance
+- [ ] Monitor PyPI download stats
+- [ ] Watch for bug reports
+- [ ] Check CI/CD status
+- [ ] Update project board
+- [ ] Close milestone (if using)
+
+### Next Version
+- [ ] Bump to next dev version in `pyproject.toml`
+- [ ] Create new CHANGELOG.md section
+- [ ] Update roadmap
+- [ ] Plan next release
+
+## Emergency Rollback
+
+If critical issues are found:
+
+1. **Yank the release on PyPI** (doesn't delete, but prevents new installs)
+   ```bash
+   # Not directly supported by uv, use twine or PyPI web interface
+   ```
+
+2. **Create hotfix release**
+   - Fix the issue
+   - Bump patch version (e.g., 0.2.0 → 0.2.1)
+   - Follow release process
+
+3. **Communicate**
+   - Update GitHub release with warning
+   - Post announcement about issue
+   - Provide workaround if available
+
+## Version-Specific Notes
+
+### v0.2.0 (Package Rename Release)
+- [ ] Verify PyPI/TestPyPI package name is `tif1`
+- [ ] Confirm install docs no longer reference `tifone`
+- [ ] Validate `import tif1` and `tif1.__version__ == "0.2.0"`
+- [ ] Check release notes mention the package rename
+- [ ] Performance benchmarks documented
+
+---
+
+**Release Manager:** _________________
+**Date:** _________________
+**Version:** _________________

tif1-0.2.0/.github/dependabot.yml

@@ -0,0 +1,32 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
+    versioning-strategy: increase
+    groups:
+      python-dependencies:
+        patterns:
+          - "*"
+    labels:
+      - "dependencies"
+      - "python"
+    commit-message:
+      prefix: "chore(deps)"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+    labels:
+      - "dependencies"
+      - "github-actions"
+    commit-message:
+      prefix: "chore(deps)"

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

@@ -0,0 +1,60 @@
+name: CI/CD
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+env:
+  UV_VERSION: "0.10.2"
+  DEFAULT_PYTHON: "3.10"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
+        uses: actions/setup-python@v6.2.0
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+
+      - name: Install uv
+        run: python -m pip install --disable-pip-version-check "uv==${UV_VERSION}"
+
+      - name: Install dependencies
+        run: python -m uv sync --all-extras
+
+      - name: Run prek checks
+        run: python -m uv run prek run --all-files --show-diff-on-failure
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6.2.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        run: python -m pip install --disable-pip-version-check "uv==${UV_VERSION}"
+
+      - name: Install dependencies
+        run: python -m uv sync --all-extras
+
+      - name: Run unit tests
+        run: |
+          python -m uv run pytest -o addopts='' tests/ -v -n auto --dist=loadfile --cov=src/tif1 --cov-report=xml --cov-report=term --cov-fail-under=80 -m "not slow and not integration and not benchmark"
+
+      - name: Run integration tests
+        if: matrix.python-version == env.DEFAULT_PYTHON
+        run: |
+          python -m uv run pytest -o addopts='' tests/ -v -n 0 --cov=src/tif1 --cov-append --cov-report=xml --cov-report=term -m integration

tif1-0.2.0/.github/workflows/docs-preview.yml

@@ -0,0 +1,89 @@
+name: Documentation Preview
+
+on:
+  pull_request:
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs-preview.yml'
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  preview:
+    name: Validate Documentation
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Check for broken links (basic)
+        run: |
+          cd docs
+          # Check for common issues in MDX files
+          echo "Checking for broken internal links..."
+
+          # Find all .mdx files and check for broken relative links
+          find . -name "*.mdx" -type f | while read file; do
+            echo "Checking $file"
+            # This is a basic check - you can enhance it
+            grep -n '\[.*\](\.\.*/.*\.mdx)' "$file" || true
+          done
+
+      - name: Validate docs.json
+        run: |
+          cd docs
+          # Check if docs.json is valid JSON
+          if ! jq empty docs.json 2>/dev/null; then
+            echo "Error: docs.json is not valid JSON"
+            exit 1
+          fi
+          echo "docs.json is valid"
+
+      - name: Comment on PR
+        uses: actions/github-script@v9
+        with:
+          script: |
+            const message = `## 📚 Documentation Preview
+
+            Your documentation changes have been validated! ✅
+
+            **Deployment:** Documentation will be automatically deployed to Mintlify when this PR is merged and a new release is published.
+
+            **Preview locally:**
+            \`\`\`bash
+            cd docs
+            npx mintlify dev
+            \`\`\`
+
+            **Note:** Mintlify auto-deploys from the \`docs-production\` branch. Changes will go live after the next release.
+            `;
+
+            // Check if we already commented
+            const { data: comments } = await github.rest.issues.listComments({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+            });
+
+            const botComment = comments.find(comment =>
+              comment.user.type === 'Bot' &&
+              comment.body.includes('📚 Documentation Preview')
+            );
+
+            if (botComment) {
+              await github.rest.issues.updateComment({
+                comment_id: botComment.id,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: message
+              });
+            } else {
+              await github.rest.issues.createComment({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: message
+              });
+            }

tif1-0.2.0/.github/workflows/docs.yml

@@ -0,0 +1,84 @@
+name: Deploy Documentation
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to deploy (e.g., v0.2.0)'
+        required: true
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-docs:
+    name: Push to docs-production branch
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Determine version
+        id: version
+        run: |
+          if [ "${{ github.event_name }}" = "release" ]; then
+            VERSION="${GITHUB_REF_NAME#v}"
+            echo "version=${VERSION}" >> $GITHUB_OUTPUT
+          elif [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            VERSION="${{ github.event.inputs.version }}"
+            VERSION="${VERSION#v}"
+            echo "version=${VERSION}" >> $GITHUB_OUTPUT
+          fi
+          echo "Deploying version: ${VERSION}"
+
+      - name: Install jq
+        run: sudo apt-get update && sudo apt-get install -y jq
+
+      - name: Update version in docs config
+        run: |
+          VERSION="${{ steps.version.outputs.version }}"
+          cd docs
+
+          # Update docs.json with version information
+          jq --arg version "$VERSION" '.version = $version' docs.json > docs.json.tmp
+          mv docs.json.tmp docs.json
+
+          # Add version to versions array if not already present
+          if ! jq -e --arg version "$VERSION" '.versions | index($version)' docs.json > /dev/null; then
+            jq --arg version "$VERSION" '.versions += [$version]' docs.json > docs.json.tmp
+            mv docs.json.tmp docs.json
+          fi
+
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Create or update docs-production branch
+        run: |
+          VERSION="${{ steps.version.outputs.version }}"
+
+          # Fetch all branches
+          git fetch origin
+
+          # Check if docs-production branch exists
+          if git ls-remote --heads origin docs-production | grep -q docs-production; then
+            echo "Branch docs-production exists, checking out"
+            git checkout docs-production
+            git pull origin docs-production
+
+            # Copy updated docs from main
+            git checkout ${{ github.sha }} -- docs/
+          else
+            echo "Creating new docs-production branch"
+            git checkout -b docs-production
+          fi
+
+          # Commit and push changes
+          git add docs/
+          git commit -m "Deploy documentation for version ${VERSION}" || echo "No changes to commit"
+          git push origin docs-production

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

@@ -0,0 +1,104 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      environment:
+        description: 'Publish to TestPyPI or PyPI'
+        required: true
+        default: 'testpypi'
+        type: choice
+        options:
+          - testpypi
+          - pypi
+
+permissions:
+  contents: read
+  id-token: write  # For trusted publishing
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.10
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Run tests
+        run: uv run pytest tests/ -v
+
+      - name: Run linting
+        run: uv run ruff check src/ tests/
+
+      - name: Run formatting check
+        run: uv run ruff format --check src/ tests/
+
+      - name: Build package
+        run: uv build
+
+      - name: Store distribution packages
+        uses: actions/upload-artifact@v7
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    if: github.event_name == 'workflow_dispatch' && github.event.inputs.environment == 'testpypi'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/tif1
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v8
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Publish to TestPyPI
+        run: uv publish --publish-url https://test.pypi.org/legacy/
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.TEST_PYPI_API_TOKEN }}
+
+  publish-pypi:
+    name: Publish to PyPI
+    if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.event.inputs.environment == 'pypi')
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/tif1
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v8
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Publish to PyPI
+        run: uv publish
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}

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

@@ -0,0 +1,53 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+        with:
+          fetch-depth: 0
+
+      - name: Generate release notes
+        run: |
+          PREV_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "")
+          VERSION="${GITHUB_REF_NAME#v}"
+
+          {
+            echo "## Changes"
+            echo
+            if [ -z "$PREV_TAG" ]; then
+              git log --pretty=format:"- %s (%h)" --no-merges
+            else
+              git log "${PREV_TAG}..HEAD" --pretty=format:"- %s (%h)" --no-merges
+            fi
+            echo
+            echo
+            echo "## Installation"
+            echo
+            echo '```bash'
+            echo "pip install tif1==${VERSION}"
+            echo '```'
+          } > RELEASE_NOTES.md
+
+      - name: Create or update GitHub release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          if gh release view "$GITHUB_REF_NAME" >/dev/null 2>&1; then
+            gh release edit "$GITHUB_REF_NAME" \
+              --title "Release $GITHUB_REF_NAME" \
+              --notes-file RELEASE_NOTES.md
+          else
+            gh release create "$GITHUB_REF_NAME" \
+              --title "Release $GITHUB_REF_NAME" \
+              --notes-file RELEASE_NOTES.md
+          fi

tif1-0.2.0/.github/workflows/wheels.yml

@@ -0,0 +1,66 @@
+name: Publish Package
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pypi-publish-${{ github.event.release.tag_name || github.ref_name }}
+  cancel-in-progress: false
+
+env:
+  UV_VERSION: "0.10.2"
+  DEFAULT_PYTHON: "3.10"
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
+        uses: actions/setup-python@v6.2.0
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+
+      - name: Install uv
+        run: python -m pip install --disable-pip-version-check "uv==${UV_VERSION}"
+
+      - name: Install dependencies
+        run: python -m uv sync --all-extras
+
+      - name: Run prek checks
+        run: python -m uv run prek run --all-files --show-diff-on-failure
+
+      - name: Run unit tests
+        run: |
+          python -m uv run pytest -o addopts='' tests/test_*.py -v -n auto --dist=loadfile --cov=src/tif1 --cov-report=xml --cov-report=term --cov-fail-under=80 -m "not slow and not integration and not benchmark"
+
+  publish:
+    needs: quality
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
+        uses: actions/setup-python@v6.2.0
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+
+      - name: Install uv
+        run: python -m pip install --disable-pip-version-check "uv==${UV_VERSION}"
+
+      - name: Install dependencies
+        run: python -m uv sync --all-extras
+
+      - name: Build distributions
+        run: python -m uv build
+
+      - name: Publish to PyPI
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+        run: python -m uv publish --token "$UV_PUBLISH_TOKEN" dist/*