tmpkit 1.0.0__tar.gz

tmpkit-1.0.0/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [MathiasPaulenko]

tmpkit-1.0.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,82 @@
+name: Bug Report
+description: Report a bug or unexpected behavior
+title: "[bug] "
+labels: ["bug", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to file a bug report! Please fill out the information below.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear description of the bug.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Minimal Reproduction
+      description: |
+        The smallest code snippet that reproduces the bug.
+      value: |
+        ```python
+        from tmpkit import temp_file
+
+        # ... your code here
+        ```
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What you expected to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened. Include full traceback if applicable.
+    validations:
+      required: true
+
+  - type: input
+    id: python-version
+    attributes:
+      label: Python Version
+      placeholder: "3.13"
+    validations:
+      required: true
+
+  - type: input
+    id: tmpkit-version
+    attributes:
+      label: tmpkit Version
+      placeholder: "0.1.0"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating System
+      options:
+        - Linux
+        - macOS
+        - Windows
+        - Other
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Any other context, logs, or screenshots.

tmpkit-1.0.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discussion
+    url: https://github.com/MathiasPaulenko/tmpkit/discussions
+    about: Ask questions and discuss ideas with the community
+  - name: Security Report
+    url: https://github.com/MathiasPaulenko/tmpkit/security/policy
+    about: Report security vulnerabilities privately (do NOT open public issues)

tmpkit-1.0.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,43 @@
+name: Feature Request
+description: Suggest a new feature or enhancement
+title: "[feat] "
+labels: ["enhancement", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for suggesting a feature! Please describe your use case clearly.
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem
+      description: What problem does this feature solve? What are you trying to do that tmpkit doesn't support?
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed Solution
+      description: Describe the API or behavior you'd like to see.
+      value: |
+        ```python
+        from tmpkit import temp_file
+
+        # proposed usage
+        ```
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives Considered
+      description: Have you considered workarounds or other approaches?
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Any other context, screenshots, or links.

tmpkit-1.0.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+## Summary
+
+<!-- Brief description of what this PR does -->
+
+## 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
+- [ ] Refactor / cleanup
+
+## Checklist
+
+- [ ] Code follows the style guidelines (`ruff check` + `ruff format` pass)
+- [ ] `mypy --strict` passes with no errors
+- [ ] Tests added for new functionality / bug fix
+- [ ] All tests pass (`pytest tests/ -v`)
+- [ ] Coverage stays >= 95%
+- [ ] `CHANGELOG.md` updated under `[Unreleased]`
+- [ ] Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/)
+
+## Related Issues
+
+<!-- Link to issues: Closes #123, Refs #456 -->

tmpkit-1.0.0/.github/dependabot.yml

@@ -0,0 +1,27 @@
+version: 2
+updates:
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: weekly
+      day: monday
+    open-pull-requests-limit: 5
+    labels:
+      - dependencies
+      - python
+    commit-message:
+      prefix: "chore"
+      include: scope
+
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+      day: monday
+    open-pull-requests-limit: 5
+    labels:
+      - dependencies
+      - github-actions
+    commit-message:
+      prefix: "chore"
+      include: scope

tmpkit-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install dev deps
+        run: pip install -e ".[dev]"
+      - name: Ruff check
+        run: ruff check tmpkit/ tests/
+      - name: Ruff format check
+        run: ruff format --check tmpkit/ tests/
+      - name: Mypy
+        run: mypy --strict tmpkit/
+      - name: Build check
+        run: python -m build --wheel
+
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dev deps
+        run: pip install -e ".[dev]"
+      - name: Pytest
+        run: pytest --cov=tmpkit --cov-report=xml --cov-branch
+      - name: Upload coverage
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13'
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./coverage.xml
+          token: ${{ secrets.CODECOV_TOKEN }}

tmpkit-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,99 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install build
+        run: pip install build
+      - name: Build dist
+        run: python -m build
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Extract release notes
+        id: notes
+        run: |
+          TAG="${GITHUB_REF_NAME}"
+          VERSION="${TAG#v}"
+          python -c "
+          import re, sys
+          version = sys.argv[1]
+          text = open('CHANGELOG.md').read()
+          pattern = rf'## \[{re.escape(version)}\](.*?)(?=## \[|\Z)'
+          match = re.search(pattern, text, re.DOTALL)
+          print(match.group(1).strip() if match else 'Release ' + version)
+          " "$VERSION" > release_notes.md
+      - name: Detect prerelease
+        id: pre
+        run: |
+          if [[ "${GITHUB_REF_NAME}" =~ ^v0\. ]] || [[ "${GITHUB_REF_NAME}" =~ (a|b|rc)[0-9]+$ ]]; then
+            echo "prerelease=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "prerelease=false" >> "$GITHUB_OUTPUT"
+          fi
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create "${GITHUB_REF_NAME}" \
+            dist/*.whl dist/*.tar.gz \
+            --title "${GITHUB_REF_NAME}" \
+            --notes-file release_notes.md \
+            ${{ steps.pre.outputs.prerelease == 'true' && '--prerelease' || '' }}
+
+  verify:
+    needs: publish-pypi
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install from PyPI
+        run: |
+          VERSION="${GITHUB_REF_NAME#v}"
+          pip install "tmpkit==${VERSION}"
+      - name: Smoke test
+        run: python -c "from tmpkit import temp_file, temp_dir; print('ok')"

tmpkit-1.0.0/.gitignore

@@ -0,0 +1,36 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+*.egg
+dist/
+build/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Tooling caches
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+coverage.xml
+*.cover
+
+# Project
+ref/

tmpkit-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.11.0
+    hooks:
+      - id: mypy
+        additional_dependencies: []
+        args: [--strict]

tmpkit-1.0.0/CHANGELOG.md

@@ -0,0 +1,103 @@
+# Changelog
+
+All notable changes to tmpkit will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Nothing yet.
+
+### Changed
+
+- Nothing yet.
+
+### Deprecated
+
+- Nothing yet.
+
+### Removed
+
+- Nothing yet.
+
+### Fixed
+
+- Nothing yet.
+
+### Security
+
+- Nothing yet.
+
+## [1.0.0] - 2025-01-24
+
+### Added
+
+- Project design documents in `ref/` (context, competitor analysis, features, design, API contract, object spec, migration guide).
+- `temp_file()` sync context manager with auto-cleanup.
+- `temp_dir()` sync context manager with auto-cleanup.
+- `temp_file()` async context manager.
+- `temp_dir()` async context manager.
+- `DEBUG=1` / `TMPKIT_DEBUG=1` environment variable to keep all temps.
+- `keep=True` parameter for per-call keep override.
+- `keep_on_error=True` parameter — keep temp only on exception (killer feature).
+- `.keep()` method — runtime decision to keep temp.
+- `cwd=True` parameter in `temp_dir()` — auto-chdir with restore.
+- `content=` parameter in `temp_file()` — pre-populate file content.
+- `dir=` parameter — specify parent directory.
+- `mode=` parameter in `temp_file()` — text/binary mode control.
+- Close-without-delete — file survives `close()`, deleted on context exit (Windows subprocess friendly).
+- `.path` attribute — `Path` object on temp file objects.
+- `__fspath__` protocol — temp objects work with `os.path`, `shutil`, `subprocess`.
+- `ignore_cleanup_errors=True` by default — best-effort cleanup on Windows.
+- `prefix=` and `suffix=` support.
+- Returns `Path` objects (not raw strings).
+- Named temps by default — Windows-safe (no `O_TEMPORARY` flag).
+- `atomic_write()` context manager — temp file + atomic rename on success.
+- `dest=` parameter in `temp_file()` — promote temp to permanent destination.
+- `@temp_dir()` and `@temp_file()` decorator support.
+- Cleanup hooks.
+- Temp registry — process-local tracking of all temps.
+
+### Changed
+
+- Nothing yet.
+
+### Deprecated
+
+- Nothing yet.
+
+### Removed
+
+- Nothing yet.
+
+### Fixed
+
+- Registry records are no longer marked `cleaned` when cleanup fails — the
+  registry now reflects on-disk reality so `cleanup_all()` can retry.
+- `cleanup_all()` no longer counts already-gone temps as deleted, and
+  re-checks record state under the lock to prevent a race condition where
+  a concurrently-kept record could be deleted.
+- `atomic_write()` no longer passes `newline`/`encoding` to `os.fdopen` in
+  binary mode (previously raised `TypeError`).
+- `.keep()` now raises `RuntimeError` if called after `__exit__` instead
+  of silently succeeding.
+- `atomic_write()` now raises `NotADirectoryError` when the destination
+  parent exists but is a file, instead of a confusing `OSError` from
+  `mkstemp`.
+- `TempFileLike` protocol `read()` signature now matches the
+  implementation (`read(size: int = -1)`).
+- `@temp_file()` decorator docstring no longer claims method support.
+- `cleanup_hook` failure no longer prevents standard cleanup — the temp
+  file/directory is always cleaned up, and the hook error is re-raised
+  after cleanup (body exceptions take precedence).
+- Context manager reuse (`__enter__` called twice) now correctly resets
+  internal state instead of raising stale `ValueError` or `RuntimeError`.
+
+### Security
+
+- `prefix` and `suffix` parameters are now validated to reject path
+  separators and absolute paths, preventing path traversal via
+  `tempfile.mkstemp`/`mkdtemp`.

tmpkit-1.0.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best for the overall community, not just us as
+  individuals
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+**conduct@mathiaspaulenko.com**.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.