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

Uploaded Python 3

File details

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

File metadata

  • Download URL: homebak-0.1.0b4.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.0b4.tar.gz
Algorithm Hash digest
SHA256 85beccbc8bb6b3738a695feaf76a8e4c2fb72f6f30d3b4ffc5f39fc2110dfe75
MD5 6eaab6c4cdb14b0172959d2aad4a932d
BLAKE2b-256 a54ae46ff836b53165bb5b84efba2a4360b57baebf5d27ef51ced3f0364aad17

See more details on using hashes here.

File details

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

File metadata

  • Download URL: homebak-0.1.0b4-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.0b4-py3-none-any.whl
Algorithm Hash digest
SHA256 012745c32343c570940ed39d3b62f59e35ee4c91c5d3e2d3239128513a970eaa
MD5 0c97732334cc04772a92b52dc4039817
BLAKE2b-256 e6eada686e832fd455496d399346f224f3544a70a8abe6e69ef414b8329977f7

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