sync_or_swim

Sync your data files across all of your machines (tinyurl.com/sync-or-swim)

project status badges:

CI Workflow Coverage Documentation Status Package Health

version badges:

Project Version Python Versions Cookiecutter: cc-python Docker: pythonboltons/main

Installation 🗹

Using pipx to Install (preferred)

This package could be installed using pip like any other Python package (in fact, see the section below this one for instructions on how to do just that). Given that we only need this package’s entry points, however, we recommend that pipx be used instead:

# install and setup pipx
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# install sync_or_swim
pipx install sync-or-swim

Using pip to Install

To install sync_or_swim using pip, run the following commands in your terminal:

python3 -m pip install --user sync-or-swim  # install sync_or_swim

If you don’t have pip installed, this Python installation guide can guide you through the process.

Command-Line Interface (CLI)

The output from running sync_or_swim --help is shown below:

``` usage: sync_or_swim [-h] [-c CONFIG_FILE] [-L [FILE[:LEVEL][@FORMAT]]] [-v] [--version] Contains the sync_or_swim package's main entry point. optional arguments: -c CONFIG_FILE, --config CONFIG_FILE Absolute or relative path to a YAML file that contains this application's configuration. -h, --help show this help message and exit -L [FILE[:LEVEL][@FORMAT]], --log [FILE[:LEVEL][@FORMAT]] This option can be used to enable a new logging handler. FILE should be either a path to a logfile or one of the following special file types: [1] 'stderr' to log to standard error (enabled by default), [2] 'stdout' to log to standard out, [3] 'null' to disable all console (e.g. stderr) handlers, or [4] '+[NAME]' to choose a default logfile path (where NAME is an optional basename for the logfile). LEVEL can be any valid log level (i.e. one of ['CRITICAL', 'DEBUG', 'ERROR', 'INFO', 'TRACE', 'WARNING']) and FORMAT can be any valid log format (i.e. one of ['color', 'json', 'nocolor']). NOTE: This option can be specified multiple times and has a default argument of '+'. -v, --verbose How verbose should the output be? This option can be specified multiple times (e.g. -v, -vv, -vvv, ...). --version show program's version number and exit ```