Skip to main content

Manage and edit $HOME dotfiles using Python + git = <3

Project description

mydot -- A Python Module for managing dotfiles

Quick Start

  1. Configure bash shell:

    # Environment variable specifying where to store dotfiles
    export DOTFILES="$HOME/.config/dotfiles"
    alias config="/usr/bin/git --git-dir=$DOTFILES --work-tree=$HOME"
    
  2. Initialize dotfiles repository

    # Initialize repository
    mkdir -pv $DOTFILES
    git init --bare $DOTFILES
    
  3. Confirm and configure dotfiles repo

    # Confirm working dotfiles alias
    config status
    # Disable display of untracked files
    config config --local status.showUntrackedFiles no
    # Confirm change
    config status
    # Add files to track using Git
    config add -v ~/.vimrc ~/.tmux.conf ~/.bashrc ~/.bash_aliases
    
  4. Get powerful with mydot

    python -m pip install --user mydot
    python -m mydot --help
    python -m mydot --status
    python -m mydot --edit
    python -m mydot --add
    

Source of Truth

This project is available on GitHub and GitLab. Each push to master automatically goes to both so choose whichever platform you prefer.

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

mydot-0.1.1.tar.gz (4.7 kB view hashes)

Uploaded Source

Built Distribution

mydot-0.1.1-py3-none-any.whl (8.2 kB view hashes)

Uploaded Python 3

Supported by

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