Skip to main content

Homekeeper

https://travis-ci.org/retiman/homekeeper.svg?branch=master Latest Version PyPI Wheel Supported versions

This project helps organize dotfiles by symlinking them from another location. You may opt to version your dotfiles using git or another SCM tool so you can have access to them easily while working on other machines.

In the event that you use multiple computers and would like dotfiles to be shared, you can have a list of dotfiles directories that will be overridden. This can be useful if you have your own personal dotfiles, but then want dotfiles for work to be located in a separate directory or repository.

Installation

Install it via pypi:

pip install homekeeper

Versions 5.0.0 and above are compatible with Python 3 only.

Versions 4.0.5 and below are compatible with Python 2 only.

Usage

Create a repository or directory to store your dotfiles (like this one), then create a $HOME/.homekeeper.json that points to that repository. Running homekeeper keep symlinks the dotfiles from the repository to your home directory.

Configuration

Homekeeper will read a $HOME/.homekeeper.json file for configuration. A simple configuration looks like this:

{
    "directories": [
        "/home/johndoe/dotfiles/base",
        "/home/johndoe/dotfiles/host"
    ],
    "excludes": [
        ".git",
        ".gitignore",
    ]
}

Note that all paths must be absolute in the directories array. Homekeeper will symlink files from each directory in order. Homekeeper will not symlink any file in the excludes array in the configuration.

For example, if you have a .bash_profile in $HOME/dotfiles, then after running homekeeper keep, your home directory will contain:

.bash_profile -> /home/$USER/dotfiles/.bash_profile

NOTE: HOMEKEEPER WILL DELETE THE ORIGINAL FILE IN YOUR HOME DIRECTORY AND CREATE A SYMLINK.

To prevent homekeeper from doing this, run with the --no-overwrite flag (although this may prevent homekeeper from doing anything useful).

Run homekeeper unkeep to undo this process.

Metadata

Release files for homekeeper 5.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for homekeeper 5.1.0
File Interpreter ABI Platform Actions
homekeeper-5.1.0-py3-none-any.whl Python 3 none any Details for homekeeper-5.1.0-py3-none-any.whl

Release files / homekeeper-5.1.0-py3-none-any.whl

Download URL homekeeper-5.1.0-py3-none-any.whl
Size 16.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
64d115abd397f7a1936e83b078f01ff2bbc2a98776977305392b14d8be907a18
BLAKE2b-256 checksum
How to use checksums
fd308164041bad5f5ab30d8756cdc10b90c6909d0fb4a1c9c4ec6401f46517af
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.2 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.5.3

Security for homekeeper 5.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page