Skip to main content

Simple, configurable home directory backup tool

Project description

🏠 homebak

homebak is a simple, configurable tool for backing up your home directory on Linux.
Exclude what you don't need, compress the rest, and keep your data safe.

🚀 Features

  • ⚙️ Configurable via YAML (~/.config/homebak/config.yaml)
  • 🗃 Exclude directories by name (e.g. .cache, venv, datasets)
  • 📦 Compressed .tar.gz output
  • 🧪 Dry run mode (--dry-run)
  • 🧼 Clean CLI with progress bars
  • 📝 Config editing via homebak edit-config

📦 Installation

pip install homebak

📁 Example Usage

homebak               # Run with confirmation
homebak --yes         # Skip confirmation
homebak --dry-run     # Simulate backup only
homebak edit-config   # Open config file in $EDITOR

⚙️ Config Example

Located at ~/.config/homebak/config.yaml:

backup_location: "/media/$USER/backup/backups"
copy_timeout: 60

exclude_directory_names:
  - ".cache"
  - ".venv"
  - "datasets"
  - "snap"

🧠 Why use homebak?

Just run it. homebak will:

  1. Walk your home directory
  2. Exclude folders you don't care about
  3. Copy the rest with timeout protection
  4. Compress everything into a single .tar.gz archive

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

homebak-0.1.0b2.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

homebak-0.1.0b2-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file homebak-0.1.0b2.tar.gz.

File metadata

  • Download URL: homebak-0.1.0b2.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for homebak-0.1.0b2.tar.gz
Algorithm Hash digest
SHA256 042ef04945126a56ee0a33585a8021cbe75ea38ba00197884450e5d854cbf087
MD5 89ab2c85028d6755bd5ddf83d66e939d
BLAKE2b-256 77fc1cda3379e0cbe37e74344048ac3d7b7182724b4baecef8457fc5a0967491

See more details on using hashes here.

File details

Details for the file homebak-0.1.0b2-py3-none-any.whl.

File metadata

  • Download URL: homebak-0.1.0b2-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for homebak-0.1.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 837693194944e3e0187583d3d7f037496aa1773b1b370a7405ac0ec657e04802
MD5 22806ee23c08b17d73a9a6dd6e437e41
BLAKE2b-256 23569090506173440477d65d1343886293f38b7f18b5ba4b54b420e8ce5cdf1f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page