trs-file-backup 2.0.1__tar.gz

trs_file_backup-2.0.1/.editorconfig

@@ -0,0 +1,21 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf
+
+[*.bat]
+indent_style = tab
+end_of_line = crlf
+
+[LICENSE]
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab

trs_file_backup-2.0.1/.github/workflows/ci.yml

@@ -0,0 +1,91 @@
+name: CI
+
+on:
+  push:
+    branches: [develop]
+  pull_request:
+    branches: [develop]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv run pre-commit run --all-files
+
+  test:
+    runs-on: ubuntu-latest
+    permissions:
+      checks: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv sync --group dev
+      - run: uv run pytest --cov-report=xml:coverage.xml --junitxml=junit.xml
+
+      - name: Upload coverage to Codecov
+        if: always()
+        uses: codecov/codecov-action@v5
+        with:
+          files: coverage.xml
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Upload test results to Codecov
+        if: always()
+        uses: codecov/codecov-action@v5
+        with:
+          files: junit.xml
+          report_type: test_results
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Publish JUnit test results
+        if: always()
+        uses: mikepenz/action-junit-report@v6
+        with:
+          report_paths: junit.xml
+          check_name: Test Results
+          fail_on_failure: true
+          require_tests: true
+          detailed_summary: true
+          include_passed: false
+
+  release:
+    needs: [lint, test]
+    if: github.event_name == 'push' && github.ref == 'refs/heads/develop'
+    runs-on: ubuntu-latest
+    environment: release
+    concurrency: release
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - name: Generate App Token
+        id: app-token
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ secrets.RELEASE_APP_ID }}
+          private-key: ${{ secrets.RELEASE_APP_PRIVATE_KEY }}
+
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ steps.app-token.outputs.token }}
+
+      - name: Release
+        uses: python-semantic-release/python-semantic-release@v9
+        id: release
+        with:
+          github_token: ${{ steps.app-token.outputs.token }}
+
+      - name: Publish GitHub Release
+        uses: python-semantic-release/publish-action@v9
+        if: steps.release.outputs.released == 'true'
+        with:
+          github_token: ${{ steps.app-token.outputs.token }}
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        if: steps.release.outputs.released == 'true'

trs_file_backup-2.0.1/.gitignore

@@ -0,0 +1,147 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Python template
+# 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
+
+# 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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder {{package_name}} settings
+.spyderproject
+.spyproject
+
+# Rope {{package_name}} settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache/
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# bootstrap files are downloaded during installation
+/.bootstrap
+
+# Local development planning files - kept for temporary use during development
+ROADMAP.md
+REVIEW.md

trs_file_backup-2.0.1/.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+exclude: "CHANGELOG\\.md|\\.all-contributorsrc|\\.vscode/.*|tests/__init__\\.py|\\.github/.*"
+default_stages: [pre-commit]
+
+ci:
+    autofix_commit_msg: "chore(pre-commit.ci): auto fixes"
+    autoupdate_commit_msg: "chore(pre-commit.ci): pre-commit autoupdate"
+
+repos:
+    - repo: https://github.com/commitizen-tools/commitizen
+      rev: v3.16.0
+      hooks:
+          - id: commitizen
+            stages: [commit-msg]
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v4.5.0
+      hooks:
+          - id: debug-statements
+          - id: check-builtin-literals
+          - id: check-case-conflict
+          - id: check-docstring-first
+          - id: check-json
+          - id: check-toml
+          - id: check-xml
+          - id: check-yaml
+          - id: detect-private-key
+          - id: end-of-file-fixer
+          - id: trailing-whitespace
+    - repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.3.0
+      hooks:
+          - id: ruff
+            args: [--fix, --exit-non-zero-on-fix]
+    - repo: https://github.com/codespell-project/codespell
+      rev: v2.2.6
+      hooks:
+          - id: codespell
+    - repo: https://github.com/pre-commit/mirrors-mypy
+      rev: v1.8.0
+      hooks:
+          - id: mypy
+            additional_dependencies: []

trs_file_backup-2.0.1/.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+  "recommendations": [
+    "charliermarsh.ruff",
+    "ms-python.python",
+    "ms-python.vscode-pylance",
+    "mystExecutableBookProject.myst-highlight",
+    "chrisjsewell.myst-tml-syntax",
+    "chrisjsewell.myst-lsp"
+  ]
+}

trs_file_backup-2.0.1/.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Python: Debug Tests",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "${file}",
+      "purpose": [
+        "debug-test"
+      ],
+      "console": "integratedTerminal",
+      "env": {
+        "PYTEST_ADDOPTS": "--no-cov"
+      },
+      "justMyCode": false
+    }
+  ]
+}

trs_file_backup-2.0.1/.vscode/settings.json

@@ -0,0 +1,36 @@
+{
+  "python.testing.pytestArgs": [
+    "tests"
+  ],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true,
+  "editor.formatOnSave": true,
+  "[python]": {
+    "editor.defaultFormatter": "charliermarsh.ruff"
+  },
+  "python.analysis.typeCheckingMode": "basic",
+  "workbench.colorCustomizations": {
+    "activityBar.activeBackground": "#c4f3fd",
+    "activityBar.background": "#c4f3fd",
+    "activityBar.foreground": "#15202b",
+    "activityBar.inactiveForeground": "#15202b99",
+    "activityBarBadge.background": "#fa65e0",
+    "activityBarBadge.foreground": "#15202b",
+    "commandCenter.border": "#15202b99",
+    "sash.hoverBorder": "#c4f3fd",
+    "statusBar.background": "#93e9fb",
+    "statusBar.foreground": "#15202b",
+    "statusBarItem.hoverBackground": "#62dff9",
+    "statusBarItem.remoteBackground": "#93e9fb",
+    "statusBarItem.remoteForeground": "#15202b",
+    "titleBar.activeBackground": "#93e9fb",
+    "titleBar.activeForeground": "#15202b",
+    "titleBar.inactiveBackground": "#93e9fb99",
+    "titleBar.inactiveForeground": "#15202b99"
+  },
+  "peacock.color": "#93e9fb",
+  "chat.tools.terminal.autoApprove": {
+    "/.*/": true
+  },
+  "chat.tools.terminal.ignoreDefaultAutoApproveRules": true
+}

trs_file_backup-2.0.1/.vscode/tasks.json

@@ -0,0 +1,65 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Install",
+      "command": "uv sync --all-groups",
+      "type": "shell",
+      "presentation": {
+        "reveal": "always"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": false
+      }
+    },
+    {
+      "label": "static analysis",
+      "command": "uv run pre-commit run --all-files",
+      "type": "shell",
+      "presentation": {
+        "reveal": "always"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": false
+      }
+    },
+    {
+      "label": "run tests",
+      "command": "uv run pytest",
+      "type": "shell",
+      "presentation": {
+        "reveal": "always"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": false
+      }
+    },
+    {
+      "label": "generate docs",
+      "command": "uv run sphinx-build -b html docs build/docs/html",
+      "type": "shell",
+      "presentation": {
+        "reveal": "always"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": false
+      }
+    },
+    {
+      "label": "open docs index.html",
+      "command": "${workspaceFolder}/build/docs/html/index.html",
+      "type": "shell",
+      "presentation": {
+        "reveal": "always"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": false
+      }
+    }
+  ]
+}

trs_file_backup-2.0.1/AGENTS.md

@@ -0,0 +1,97 @@
+# trs-file-backup - Agent Instructions
+
+## Project Overview
+
+This is a Python CLI tool for monitoring directories and creating timestamped backups of modified files. The project uses uv for dependency management and follows strict conventional commit standards.
+
+## Key Technologies
+
+- **Language**: Python 3.10+
+- **CLI Framework**: Typer + Rich (for terminal UI)
+- **File Watching**: Watchdog
+- **Build Tool**: uv + hatchling
+- **Testing**: Pytest + Pester (PowerShell tests)
+- **Linting**: Ruff
+- **CI/CD**: GitHub Actions with semantic-release
+- **Versioning**: Semantic Release (automatic based on conventional commits)
+
+## Project Structure
+
+- `src/trs_file_backup/` - Main source code
+- `tests/` - Python and PowerShell tests
+- `docs/` - Sphinx documentation
+- `build.ps1` - Development setup script
+- `pyproject.toml` - PEP 621 project configuration and dependencies
+
+## Important Context
+
+### CLI Commands
+
+The tool provides three main commands:
+
+- `trs-file-backup init` - Initialize backup tracking
+- `trs-file-backup run` - One-time backup
+- `trs-file-backup watch` - Continuous monitoring mode
+
+### Backup Behavior
+
+- Only monitors **top-level files** in source directory (no subdirectories)
+- Stores all backups in a **flat structure** in destination directory
+- Backup filename format: `original_YYYY_MM_DD__HH_MM_SS.ext`
+- Tracks state in `.backup_state.json` (stored in backup directory)
+- Logs to `backup.log`
+
+### Development Workflow
+
+1. **Setup**: Run `uv sync --all-groups` to install dependencies
+2. **Testing**: Run `uv run pytest` for all tests
+3. **Pre-commit**: Run `uv run pre-commit run --all-files` before committing
+4. **Commits**: MUST follow conventional commit format (enforced by commitlint)
+
+### Commit Standards
+
+This project uses **strict conventional commits**. Every commit message must follow:
+
+```text
+<type>(<scope>): <subject>
+```
+
+**Version Impact**:
+
+- `feat:` → Minor version bump (1.0.0 → 1.1.0)
+- `fix:` → Patch version bump (1.0.0 → 1.0.1)
+- `feat!:` or `fix!:` → Major version bump (breaking change)
+- `docs:`, `style:`, `refactor:`, `test:`, `chore:` → No version bump
+
+### Release Process
+
+- **Automatic**: GitHub Actions on `develop` branch
+- **Semantic Release**: Analyzes commits and auto-bumps version
+- **Version Files**: Synchronized in `pyproject.toml`, `src/trs_file_backup/__init__.py`, `docs/conf.py`
+- **Changelog**: Auto-generated in `CHANGELOG.md`
+- **Publishing**: Tag builds publish to PyPI
+
+## Code Guidelines
+
+- **Ruff Configuration**: Line length 180, specific ignores for docstrings
+- **Type Hints**: Required (mypy strict mode)
+- **Test Coverage**: Required with pytest-cov
+- **Python Version**: Minimum 3.10
+
+## When Making Changes
+
+1. **Code Changes**: Keep modifications minimal and surgical
+2. **Tests**: Update or add tests as needed
+3. **Documentation**: Update README.md if user-facing features change
+4. **Version**: Never manually change version numbers (automatic via semantic-release)
+5. **Commits**: Use correct conventional commit type for version bumping
+
+## Package Distribution
+
+- **Registry**: Published to PyPI (public)
+- **License**: MIT
+- **Installation**: `pip install trs-file-backup`
+
+## PowerShell Integration
+
+The project includes PowerShell scripts and Pester tests. Pester 5.x is required for development.