Metadata-Version: 2.0
Name: stowage
Version: 0.1.6
Summary: Stow-like application for keeping your dot-files under version control
Home-page: https://github.com/michaelpb/stowage
Author: michaelb
Author-email: michaelpb@gmail.com
License: GPL3
Keywords: stowage
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)

stowage
=======

.. figure:: https://badge.fury.io/py/stowage.png
   :alt: stowage badge

   stowage badge

.. figure:: https://travis-ci.org/michaelpb/stowage.png?branch=master
   :alt: travis badge

   travis badge

Stow-like designed for keeping dotfiles under version control, written
in python

Installation
------------

Assuming Python's ``pip`` is installed (for Debian-based systems, this
can be installed with ``sudo apt-get install python-pip``), stowage can
be installed directly from PyPI:

::

    pip install stowage

Python versions 3.3+ (and 2.6+) are supported and tested against.

Quick start
-----------

1. Setup your dotfiles repo (by default ``stowage`` assumes its at
   ``~/dotfiles``, but it could be anywhere)

::

    mkdir ~/dotfiles
    cd ~/dotfiles
    git init

2. Create one or more dotfile 'packages'

::

    # An example, making one for your .vimrc
    # Notice that we can call it _vimrc instead of .vimrc, making it visible /
    # easier to interact with
    mkdir ~/dotfiles/vim
    cp ~/.vimrc ~/dotfiles/vim/_vimrc

3. Activate ``stowage``

::

    stowage vim

Now, your ``~/.vimrc`` has been replaced by a symlink to the
``~/dotfiles/vim/_vimrc`` file, enabling the ``~/dotfiles`` directory to
be more easily put into version control.

Full usage
----------

::

    usage: stowage [-h] [-n] [-v] [-s SOURCE] [-d DESTINATION] [-b BACKUP] [-B]
                   [packages [packages ...]]

    Symlink files recursively, good for dotfiles.

    positional arguments:
      packages              one or more packages

    optional arguments:
      -h, --help            show this help message and exit
      -n, --dryrun          dryrun, just simulate
      -v, --verbose         increase output verbosity
      -s SOURCE, --source SOURCE
                            stowage source directory
      -d DESTINATION, --destination DESTINATION
                            stowage destination directory
      -b BACKUP, --backup BACKUP
                            stowage backup directory
      -B, --skip-backup     skip making backups

Contributing
============

New features, tests, and bug fixes are welcome!






