backfort 1.3.0__tar.gz

backfort-1.3.0/.gitignore

@@ -0,0 +1,103 @@
+# Local configuration and secrets
+config.yaml
+config.local.yaml
+config.*.local.yaml
+config.secret.yaml
+config.*.secret.yaml
+.env
+.env.*
+!.env.example
+environment
+*.key
+*.pem
+*.p12
+*.pfx
+*.crt
+*.credentials
+*.secret
+
+# Runtime data
+*.log
+*.log.*
+*.pid
+*.lock
+*.state
+*.last-action
+logs/
+state/
+run/
+
+# Temporary files and test artifacts
+.test-bin/
+.tmp/
+tmp/
+temp/
+coverage/
+test-results/
+*.tmp
+*.temp
+*.bak
+*.old
+*.orig
+*.rej
+*~
+
+# IDEs and editors
+.idea/
+*.iml
+*.ipr
+*.iws
+.vscode/
+!.vscode/extensions.json
+!.vscode/settings.example.json
+.fleet/
+.zed/
+*.swp
+*.swo
+*.swn
+
+# Operating-system metadata
+.DS_Store
+.AppleDouble
+.LSOverride
+._*
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+Desktop.ini
+$RECYCLE.BIN/
+.Spotlight-V100/
+.Trashes/
+
+# Tool caches and reports
+.cache/
+.pytest_cache/
+__pycache__/
+*.py[cod]
+.mypy_cache/
+.ruff_cache/
+.shellcheckrc.local
+*.lcov
+
+# Archives and release artifacts
+dist/
+build/
+release/
+*.tar
+*.tar.gz
+*.tgz
+*.zip
+
+*.partial.*
+.backfort-test/
+
+.ai/
+.codex/
+.cursor/
+.windsurfrules
+AGENTS.md
+AI_CONTEXT.md
+CLAUDE.md
+GEMINI.md
+KIMI.md
+MANUS.md

backfort-1.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Igor Sazonov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

backfort-1.3.0/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: backfort
+Version: 1.3.0
+Summary: Recovery-first Linux backups for files, Docker Compose and databases
+Project-URL: Homepage, https://github.com/shellharbor/backfort
+Project-URL: Documentation, https://github.com/shellharbor/backfort/tree/main/wiki
+Project-URL: Repository, https://github.com/shellharbor/backfort
+Project-URL: Issues, https://github.com/shellharbor/backfort/issues
+Author: Igor Sazonov
+License-Expression: MIT
+License-File: LICENSE
+Keywords: backup,docker-compose,encryption,restore,s3
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Unix Shell
+Classifier: Topic :: System :: Archiving :: Backup
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: build<2,>=1.2.2; extra == 'dev'
+Requires-Dist: coverage[toml]<8,>=7.6; extra == 'dev'
+Requires-Dist: hatchling<2,>=1.27; extra == 'dev'
+Requires-Dist: ruff<1,>=0.12; extra == 'dev'
+Requires-Dist: twine<7,>=6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Backfort for Python
+
+Recovery-first Linux backups for files, Docker Compose applications and databases.
+This distribution bundles Backfort's canonical Bash engine and example YAML;
+it is a Python launcher, **not a Python rewrite** or a new backup format.
+
+## Requirements
+
+- Python 3.11+ and Linux. Use WSL or the existing Docker image on Windows.
+- Bash 4.3+, GNU tar, coreutils, findutils, util-linux and gzip.
+- Mike Farah `yq` v4. The Python package named `yq` is not compatible.
+- Feature-specific tools such as rclone, age, GPG, Minisign or Docker Compose
+  when the job enables them. Python installation does not install system tools.
+
+## Install and run
+
+Install Backfort 1.3.0 with pipx, keeping the launcher isolated:
+
+```bash
+pipx install 'backfort==1.3.0'
+backfort --version
+```
+
+Or install inside a virtual environment:
+
+```bash
+python3 -m venv .venv
+.venv/bin/python -m pip install 'backfort==1.3.0'
+.venv/bin/backfort --version
+.venv/bin/python -m backfort --help
+```
+
+From a trusted source checkout, replace the install target with `.`.
+Do not install into a system-managed Python. For privileged backups, use a
+protected installation, never a user-writable environment executed as root.
+No package is downloaded, published or installed system-wide by the Backfort
+launcher itself.
+
+The installed `backfort` command and `python -m backfort` accept the same
+arguments as `backfort.sh`. From a checkout, `python3 run_backfort.py` works
+without installing the package, including from another working directory.
+The launcher replaces itself with Bash, preserving arguments, environment,
+terminal I/O, signals and the engine's exit status. It does not invoke a shell
+command string, download a script, install dependencies or elevate privileges.
+
+## First configuration
+
+Print the bundled reference config to stdout. Choose a new filename: shell
+redirection overwrites an existing file.
+
+```bash
+.venv/bin/backfort --print-example-config > backfort.example.yaml
+```
+
+Edit its host ID, source paths, destination paths, encryption and retention
+before use. Paths are absolute, and backup/state/work directories must stay
+outside the source tree. Then validate the plan:
+
+```bash
+.venv/bin/backfort -c "$PWD/backfort.example.yaml" doctor
+.venv/bin/backfort -c "$PWD/backfort.example.yaml" --dry-run run
+.venv/bin/backfort -c "$PWD/backfort.example.yaml" run
+.venv/bin/backfort -c "$PWD/backfort.example.yaml" list
+```
+
+The sole launcher-specific flag is `--print-example-config`, used alone. All
+other argument parsing and validation belong to the existing Bash CLI.
+
+## Quick backup
+
+```bash
+.venv/bin/backfort quick /srv/application \
+  --name before-upgrade \
+  --to /srv/backups/backfort \
+  --state-directory /var/lib/backfort \
+  --exclude '*.log'
+```
+
+The execution account needs access to those paths. Quick mode saves a
+non-secret recovery config in the chosen state directory. Use a saved YAML
+job for encryption, signing, lifecycle hooks and Prometheus textfile metrics.
+
+## Verify and recover
+
+```bash
+.venv/bin/backfort -c /etc/backfort/config.yaml \
+  verify latest --job application --full
+.venv/bin/backfort -c /etc/backfort/config.yaml \
+  restore latest --job application --to /srv/empty-recovery
+```
+
+Adapt the job name. Recovery requires a new or empty target and the necessary
+keys. Preserve the original `host_id` for automatic `latest` discovery, or
+deliberately select a full backup ID. Full ownership/ACL/xattr recovery needs
+the same privileges and filesystem support as the native Bash installation.
+
+Exit codes remain `0` success, `1` partial copies, `2` invalid input or
+prerequisites, and `3` an operational/copy-policy failure. Launcher errors also
+return `2`. Pruning is a separate command; backup creation does not prune.
+
+## Learn more
+
+- [Repository and full documentation](https://github.com/shellharbor/backfort)
+- [Python installation and publishing](https://github.com/shellharbor/backfort/blob/main/wiki/Python-and-PyPI.md)
+- [Examples](https://github.com/shellharbor/backfort/tree/main/examples)
+- [Security policy](https://github.com/shellharbor/backfort/blob/main/SECURITY.md)
+- [MIT License](https://github.com/shellharbor/backfort/blob/main/LICENSE)