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.0b1.tar.gz (5.4 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.0b1-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: homebak-0.1.0b1.tar.gz
  • Upload date:
  • Size: 5.4 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.0b1.tar.gz
Algorithm Hash digest
SHA256 5a1505301428a60bf933b02a55d0c8467d69371cb5a99a144064bc3567e37933
MD5 eb65bda6b591f010e4215c0fbd668a43
BLAKE2b-256 1da5a05efdb2cc52da4b63a20addc26520a613708d714f2c2827c9eb49f525df

See more details on using hashes here.

File details

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

File metadata

  • Download URL: homebak-0.1.0b1-py3-none-any.whl
  • Upload date:
  • Size: 6.5 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.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 c3da608cc1a1ffdb038d9a71869f3566afe7c238fef611cd02890287e6972a4a
MD5 7baa7cd3d0351b6b4aa95d29b7109fff
BLAKE2b-256 d2d695619bfd5243b0ca351490ed0add43269c5f1ac60d70899eab43b0b69b49

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