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 --compress    # Compress at the end of the backup
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 if flag is set

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.0b5.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.0b5-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: homebak-0.1.0b5.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.0b5.tar.gz
Algorithm Hash digest
SHA256 fbb63f1e0ce6a1cb94374453a4896bfc4ce5b96d6cdd991022ecb56038a048d7
MD5 a52bca1700cef99948150178bbf25f37
BLAKE2b-256 078d44754e1a17176586aaa2563cb01b2a581ef4db87bdd48857f3d60403175b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: homebak-0.1.0b5-py3-none-any.whl
  • Upload date:
  • Size: 6.7 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.0b5-py3-none-any.whl
Algorithm Hash digest
SHA256 56d29cb50ae3849fd1a2f165bef12d3c397a35772593f9db1131ec44c8d4dc57
MD5 db3d991de0633498386de8685d3ac69d
BLAKE2b-256 c96ed207d59e814a2f235ac26de7b0a16cd3b9330b72aa5dc996c6be3d8b805a

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