Skip to main content

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.

  1. .pypirc
  2. .ssh
  3. .vim
  4. .zshrc

Package/Application Install Lists

Creates install lists for the following package managers in a nested installs directory.

  1. brew
  2. brew cask
  3. npm
  4. gem
  5. pip
  6. System Applications directory

Installed Fonts

Creates a list of fonts from ~/Library/Fonts in a nested fonts directory.

Installation Options

  1. Install with pip

    • $ pip install shallowBackup
    • $ shallowBackup
  2. Download the shallowBackup binary from Releases tab.

How to Contribute

  1. Clone repo and create a new branch: $ git checkout https://github.com/alichtman/shallowBackup -b name_for_new_branch.
  2. Make changes and test
  3. Submit Pull Request with comprehensive description of changes

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for shallow-backup, version 0.3
Filename, size File type Python version Upload date Hashes
Filename, size shallow_backup-0.3-py2.py3-none-any.whl (3.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page