Easily create text documentation of installed applications, dotfiles, and more.
Project description
shallow-backup
shallow-backup
is designed to make it incredibly simple for developers to document their Mac configurations.
TODO: INSERT DEMO HERE
shallow-backup
makes copies of your dotfiles
, package and application install lists, and font lists in .txt
format.
Example Use Case
Instead of backing up your brew
/ npm
/ pip
/ whatever package manager
library in a system image, which may occupy GBs of space, use shallow-backup
to create lists of the packages installed, which takes up minimal space and can be easily distributed, saved, or transported.
Usage
Usage: shallow-backup.py [OPTIONS]
Easily create text documentation of installed applications, dotfiles, and more.
Options:
-complete Backup everything.
-dotfiles Create backup folder of dotfiles.
-installs Create backup text files of app install lists.
-v Display version and author information and exit.
-help, -h Show this message and exit.
Reinstalling is easy!
Just run $ package_manager install package_manager_list.txt
.
For example, $ brew install brew_list.txt
would reinstall all brew packages listed in brew_list.txt
.
What can I document?
Dotfiles
Copies the following files into a nested dotfiles
directory.
.pypirc
.ssh
.vim
.zshrc
Package/Application Install Lists
Creates install lists for the following package managers in a nested installs
directory.
brew
brew cask
npm
gem
pip
- System
Applications
directory
Installed Fonts
Creates a list of fonts from ~/Library/Fonts
in a nested fonts
directory.
Installation Options
-
Install with
pip
$ pip install shallowBackup
$ shallowBackup
-
Download the
shallowBackup
binary from Releases tab.
How to Contribute
- Clone repo and create a new branch:
$ git checkout https://github.com/alichtman/shallowBackup -b name_for_new_branch
. - Make changes and test
- Submit Pull Request with comprehensive description of changes
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for shallow_backup-0.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0de50db762a726989c53c803521fbd034cbc67b233a4f16792e86f17466f085 |
|
MD5 | fddbfbd229b4993ce0edad470fb5843e |
|
BLAKE2b-256 | 591205ff001e8e54d83af93d19e66277103a25518d510677c76723c98acfe45e |