zensols-grsync 0.0.8

Synchronize and manage multiple GitHub repositories

Persist and create build out environments in a nascent account

This program captures your home directory and synchronize it with another host using Git repo metadata, symbolic links and persisted files.

I wrote this because I couldn't find anything that creates repositories with the idea of having a portable and easy to recreate your home directory on another host. If I've reinvented the wheel, please let me know :)

More specifically: it persists and creates build out environments in a nascent account. The program memorizing a users home directory and building it out on another system. This is done by:

1. Copying files, directories and git repos configuration.
2. Creating a distribution compressed file.
3. Uncompress on the destination system and create repos.

A future release will also synchronize and manage multiple GitHub repositories.

Table of Contents

• Obtaining
• Usage
  • Repository Information
  • Command Line Help
• Symbolic Links
• Requirements
• Changelog
• License

Obtaining

The easist way to install the command line program is via the pip installer:

pip install zensols.grsync

Binaries are also available on pypi.

Usage

The program has two phases: freeze and thaw. Git repositories (URLs and configuration, not files), symbolic links (see caveat) and files are first froozen into a distribution zip.

This distribution file is then copied to the target machine that is to be configured with the user's home directory setup. The distribution also includes a bootstrap script that creates a Python virtual environment and then invokes the program to thaw the distributing.

1. Install the grsync program.

2. Decide what you want to transfer to the target system (see test configuration file). This file explains each section of the file with inline comments and should be sufficient to munge your own.

3. Create the distribution, for example: grsync freeze -c grsync.yml -d ./dist.

4. Copy the distribution zip file to the host, for example: scp -r ./dist ~/<somehost>

5. Log into that host: slogin <host>

6. Call the bootstrapper: cd ./dist && ./bootstrap.sh /usr/bin ./dist python3.6 This attempts to create the Python virtual environment, install the program dependencies and thaw the distribution.

   To do this step manually:

   1. Install the grsync program.
   2. Thaw the distribution on the target: grsync thaw -d ./dist

Repository Information

As you build your grsync.yml configuration file, it's helpful to see what repositories it's finding. This is you can do this with the repos and repoinfo, which show repositories, remotes, and indexed symbol links to or within the repositories.

Command Line Help

This information is given by the command line grsync -h, but repeated here for convenience:

Usage: usage: grsync <list|freeze|info|repoinfo|repos|thaw> [options]

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -w NUMBER, --whine=NUMBER
                        add verbosity to logging
  -c FILE, --config=FILE
                        configuration file
Actions:
  freeze    Create a distribution
  -d, --distdir <string>                    the location of build out distribution
  --wheeldep <string>       zensols.grsync  used to create the wheel dep files

  info      Pretty print discovery information

  repoinfo  Get information on repositories
  -n, --name <string>                       comma spearated list of repo names

  repos     Output all repository top level info
  -f, --format <string>     {name}          format string (i.e. {name}: {path} ({remotes}))

  thaw      Build out a distribution
  -d, --distdir <string>                    the location of build out distribution
  -t, --targetdir <string>                  the location of build out target dir

Symbolic Links

As mentioned in the usage section, symbolic links pointing to any file in a repository are froozen, which means that integrity at thaw time is ensured. However, links not pointing to a repository are currently persisted, but the files and directories they point to are not.

A future release might have a follow symbolic links type functionality that allows this. However, for now, you must include both the link and the data it points to get this integrity.

Requirements

• At least Python 3.6
• A system that supports PyYAML

Changelog

An extensive changelog is available here.

License

Copyright (c) 2018 Paul Landes

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.