Metadata-Version: 2.1
Name: dotdrop
Version: 1.5.2
Summary: Save your dotfiles once, deploy them everywhere
Home-page: https://github.com/deadc0de6/dotdrop
Author: deadc0de6
Author-email: deadc0de6@foo.bar
License: GPLv3
Download-URL: https://github.com/deadc0de6/dotdrop/archive/v1.5.2.tar.gz
Description: # DOTDROP
        
        [![Tests Status](https://github.com/deadc0de6/dotdrop/workflows/tests/badge.svg)](https://github.com/deadc0de6/dotdrop/actions)
        [![Doc Status](https://readthedocs.org/projects/dotdrop/badge/?version=latest)](https://dotdrop.readthedocs.io/en/latest/?badge=latest)
        [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
        [![Coverage Status](https://coveralls.io/repos/github/deadc0de6/dotdrop/badge.svg?branch=master)](https://coveralls.io/github/deadc0de6/dotdrop?branch=master)
        [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/deadc0de6/dotdrop.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/deadc0de6/dotdrop/context:python)
        
        [![PyPI version](https://badge.fury.io/py/dotdrop.svg)](https://badge.fury.io/py/dotdrop)
        [![AUR](https://img.shields.io/aur/version/dotdrop.svg)](https://aur.archlinux.org/packages/dotdrop)
        [![Python](https://img.shields.io/pypi/pyversions/dotdrop.svg)](https://pypi.python.org/pypi/dotdrop)
        
        [![Donate](https://img.shields.io/badge/donate-KoFi-blue.svg)](https://ko-fi.com/deadc0de6)
        
        *Save your dotfiles once, deploy them everywhere*
        
        [Dotdrop](https://github.com/deadc0de6/dotdrop) makes the management of dotfiles between different hosts easy.
        It allows to store your dotfiles on git and automagically deploy
        different versions of the same file on different setups.
        
        It also allows to manage different *sets* of dotfiles.
        For example you can have a set of dotfiles for your home laptop and
        a different set for your office desktop. Those sets may overlap and different
        versions of the same dotfiles can be deployed on different predefined *profiles*.
        Or you may have a main set of dotfiles for your
        everyday's host and a sub-set you only need to deploy to temporary
        hosts (cloud VM, etc) that may be using
        a slightly different version of some of the dotfiles.
        
        Features:
        
        * Sync once every dotfile on git for different usages
        * Allow dotfiles templating by leveraging [jinja2](https://palletsprojects.com/p/jinja/)
        * Dynamically generated dotfile contents with pre-defined variables
        * Comparison between deployed and stored dotfiles
        * Handling multiple profiles with different sets of dotfiles
        * Easy import and update dotfiles
        * Handle files and directories
        * Support symlink of dotfiles
        * Associate actions to the deployment of specific dotfiles
        * Associate transformations for storing encrypted/compressed dotfiles
        * Provide solutions for handling dotfiles containing sensitive information
        
        Check also the [blog post](https://deadc0de.re/articles/dotfiles.html),
        the [example](#getting-started), the [documentation](https://dotdrop.readthedocs.io/) or
        how [people are using dotdrop](https://dotdrop.readthedocs.io/en/latest/misc/people-using-dotdrop/)
        for more.
        
        Quick start:
        ```bash
        mkdir dotfiles && cd dotfiles
        git init
        git submodule add https://github.com/deadc0de6/dotdrop.git
        pip3 install -r dotdrop/requirements.txt --user
        ./dotdrop/bootstrap.sh
        ./dotdrop.sh --help
        ```
        
        A mirror of this repository is available on gitlab under <https://gitlab.com/deadc0de6/dotdrop>.
        
        ## Why dotdrop ?
        
        There exist many tools to manage dotfiles however not
        many allow to deploy different versions of the same dotfile
        on different hosts. Moreover dotdrop allows to specify the
        set of dotfiles that need to be deployed on a specific profile.
        
        See the [example](#getting-started) for a concrete example on
        why [dotdrop](https://github.com/deadc0de6/dotdrop) rocks.
        
        ---
        
        **Table of Contents**
        
        * [Installation](#installation)
        * [Getting started](#getting-started)
        * [Documentation](#documentation)
        * [Thank you](#thank-you)
        
        # Installation
        
        There are multiple ways to install and use dotdrop.
        It is recommended to install dotdrop [as a submodule](#as-a-submodule)
        to your dotfiles git tree. Having dotdrop as a submodule guarantees that anywhere
        you are cloning your dotfiles git tree from you'll have dotdrop shipped with it.
        
        Below instructions show how to install dotdrop as a submodule. For alternative
        installation instructions (with virtualenv, pypi, aur, snap, etc) see the
        [installation documentation](https://dotdrop.readthedocs.io/en/latest/installation/).
        
        Dotdrop is also available on
        * pypi: https://pypi.org/project/dotdrop/
        * aur (stable): https://aur.archlinux.org/packages/dotdrop/
        * aur (git version): https://aur.archlinux.org/packages/dotdrop-git/
        * snapcraft: https://snapcraft.io/dotdrop
        
        ## As a submodule
        
        The following will create a git repository for your dotfiles and
        keep dotdrop as a submodule:
        ```bash
        ## create the repository
        $ mkdir dotfiles; cd dotfiles
        $ git init
        
        ## install dotdrop as a submodule
        $ git submodule add https://github.com/deadc0de6/dotdrop.git
        $ pip3 install -r dotdrop/requirements.txt --user
        $ ./dotdrop/bootstrap.sh
        
        ## use dotdrop
        $ ./dotdrop.sh --help
        ```
        
        For MacOS users, make sure to install `realpath` through homebrew
        (part of *coreutils*).
        
        Using dotdrop as a submodule will need you to work with dotdrop by
        using the generated script `dotdrop.sh` at the root
        of your dotfiles repository. Note that this script updates the submodule
        automatically, unless called with the environment variable `DOTDROP_AUTOUPDATE`
        set to `no`.
        
        To ease the use of dotdrop, it is recommended to add an alias to it in your
        shell (*~/.bashrc*, *~/.zshrc*, etc) with the config file path, for example
        ```
        alias dotdrop='<absolute-path-to-dotdrop.sh> --cfg=<path-to-your-config.yaml>'
        ```
        
        Completion scripts exist for `bash`, `zsh` and `fish`, see [the related doc](completion/README.md).
        
        # Getting started
        
        [Create a new repository](https://dotdrop.readthedocs.io/en/latest/repository-setup/)
        to store your dotfiles with dotdrop. *Init* or *clone* that new repository and
        [install dotdrop](https://dotdrop.readthedocs.io/en/latest/installation/#as-a-submodule).
        
        Then import any dotfiles (files or directories) you want to manage with dotdrop.
        You can either use the default profile (which resolves to the *hostname* of the host
        you are running dotdrop on) or provide it specifically using the switch `-p --profile`.
        
        Import dotfiles on host *home*
        ```bash
        $ dotdrop import ~/.vimrc ~/.xinitrc ~/.config/polybar
        ```
        
        Dotdrop does two things:
        
        * Copy the dotfiles in the *dotpath* directory
          (defined in `config.yaml`, defaults to *dotfiles*)
        * Create the associated entries in the `config.yaml` file
          (in the `dotfiles` and `profiles` entries)
        
        Your config file will look something similar to this
        ```yaml
        config:
          backup: true
          banner: true
          create: true
          dotpath: dotfiles
          ignoreempty: false
          keepdot: false
          longkey: false
          showdiff: false
          workdir: ~/.config/dotdrop
        dotfiles:
          d_polybar:
            dst: ~/.config/polybar
            src: config/polybar
          f_vimrc:
            dst: ~/.vimrc
            src: vimrc
          f_xinitrc:
            dst: ~/.xinitrc
            src: xinitrc
        profiles:
          home:
            dotfiles:
            - f_vimrc
            - f_xinitrc
            - d_polybar
        ```
        For a description of the different fields and their use,
        see the [config doc](https://dotdrop.readthedocs.io/en/latest/config-format/).
        
        Commit and push your changes with git.
        
        Then go to another host where your dotfiles need to be managed as well,
        clone the previously setup repository
        and compare the local dotfiles with the ones stored in dotdrop:
        ```bash
        $ dotdrop compare --profile=home
        ```
        
        Now you might want to adapt the `config.yaml` file to your likings on
        that second host. Let's say for example that you only want `d_polybar` and
        `f_xinitrc` to be deployed on that second host. You would then change your config
        to something like this (considering that the second host's hostname is *office*):
        ```yaml
        …
        profiles:
          home:
            dotfiles:
            - f_vimrc
            - f_xinitrc
            - d_polybar
          office:
            dotfiles:
            - f_xinitrc
            - d_polybar
        ```
        
        Then adapt any dotfile using the [templating](https://dotdrop.readthedocs.io/en/latest/templating/)
        feature (if needed). For example you might want different fonts sizes on polybar for the different
        hosts:
        
        edit `<dotpath>/config/polybar/config`
        ```bash
        …
        {%@@ if profile == "home" @@%}
        font0 = sans:size=10;0
        {%@@ elif profile == "office" @@%}
        font0 = sans:size=14;0
        {%@@ endif @@%}
        font1 = "Material Design Icons:style=Regular:size=14;0"
        font2 = "unifont:size=6;0"
        …
        ```
        
        Also the home computer is running [awesomeWM](https://awesomewm.org/)
        and the office computer [bspwm](https://github.com/baskerville/bspwm).
        The `~/.xinitrc` file will therefore be different while still sharing some lines.
        
        edit `<dotpath>/xinitrc`
        ```bash
        #!/bin/bash
        
        # load Xresources
        userresources=$HOME/.Xresources
        if [ -f "$userresources" ]; then
              xrdb -merge "$userresources" &
        fi
        
        # launch the wm
        {%@@ if profile == "home" @@%}
        exec awesome
        {%@@ elif profile == "office" @@%}
        exec bspwm
        {%@@ endif @@%}
        ```
        
        The *if branch* on above template examples will define
        which part is deployed based on the
        hostname of the host on which dotdrop is run from
        (or the selected profile).
        
        When done, you can install your dotfiles using
        ```bash
        $ dotdrop install
        ```
        If you are unsure, you can always run `dotdrop compare` to see
        how your local dotfiles would be updated by dotdrop before running
        `install` or run install with `--dry`.
        
        That's it, a single repository with all your dotfiles for your different hosts.
        
        You can then
        
        * [create actions](https://dotdrop.readthedocs.io/en/latest/config-details/#entry-actions)
        * [use transformations](https://dotdrop.readthedocs.io/en/latest/config-details/#entry-transformations)
        * [use variables](https://dotdrop.readthedocs.io/en/latest/config/#variables)
        * [symlink dotfiles](https://dotdrop.readthedocs.io/en/latest/config/#symlink-dotfiles)
        * [and more](https://dotdrop.readthedocs.io/en/latest/howto/howto/)
        
        For more options see `dotdrop --help` and the [documentation](https://dotdrop.readthedocs.io).
        
        # Documentation
        
        Dotdrop's documentation is hosted on [readthedocs](https://dotdrop.readthedocs.io/en/latest/).
        
        # Thank you
        
        If you like dotdrop, [buy me a coffee](https://ko-fi.com/deadc0de6).
        
        # Contribution
        
        If you are having trouble installing or using dotdrop,
        [open an issue](https://github.com/deadc0de6/dotdrop/issues).
        
        If you want to contribute, feel free to do a PR (please follow PEP8).
        Have a look at the
        [contribution guidelines](https://github.com/deadc0de6/dotdrop/blob/master/CONTRIBUTING.md)
        
        # License
        
        This project is licensed under the terms of the GPLv3 license.
        
Keywords: dotfiles jinja2
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Requires-Python: >=3
Provides-Extra: dev
Provides-Extra: test
