Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bbugyi200/sync-or-swim
Sync data files across all of your machines (tinyurl.com/sync-or-swim)
https://github.com/bbugyi200/sync-or-swim
cc-python python
Last synced: 7 days ago
JSON representation
Sync data files across all of your machines (tinyurl.com/sync-or-swim)
- Host: GitHub
- URL: https://github.com/bbugyi200/sync-or-swim
- Owner: bbugyi200
- Created: 2022-09-17T22:13:56.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-09-18T20:05:02.000Z (about 2 years ago)
- Last Synced: 2024-10-14T06:26:50.753Z (about 1 month ago)
- Topics: cc-python, python
- Language: Shell
- Homepage: https://sync-or-swim.readthedocs.io/en/latest
- Size: 41 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# sync_or_swim
**Sync your data files across all of your machines (tinyurl.com/sync-or-swim)**
_project status badges:_
[](https://github.com/bbugyi200/sync-or-swim/actions/workflows/ci.yml)
[](https://codecov.io/gh/bbugyi200/sync-or-swim)
[](https://sync-or-swim.readthedocs.io/en/latest/?badge=latest)
[](https://snyk.io/advisor/python/sync-or-swim)
_version badges:_
[](https://pypi.org/project/sync-or-swim/)
[](https://pypi.org/project/sync-or-swim/)
[](https://github.com/python-boltons/cc-python)
[](https://github.com/python-boltons/docker-python)
## 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][11] be used instead:
```shell
# 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][9], run the following
commands in your terminal:
``` shell
python3 -m pip install --user sync-or-swim # install sync_or_swim
```
If you don't have pip installed, this [Python installation guide][10] 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
```
## Useful Links 🔗
* [API Reference][3]: A developer's reference of the API exposed by this
project.
* [cc-python][4]: The [cookiecutter][5] that was used to generate this project.
Changes made to this cookiecutter are periodically synced with this project
using [cruft][12].
* [CHANGELOG.md][2]: We use this file to document all notable changes made to
this project.
* [CONTRIBUTING.md][7]: This document contains guidelines for developers
interested in contributing to this project.
* [Create a New Issue][13]: Create a new GitHub issue for this project.
* [Documentation][1]: This project's full documentation.
[1]: https://sync-or-swim.readthedocs.io/en/latest
[2]: https://github.com/bbugyi200/sync-or-swim/blob/master/CHANGELOG.md
[3]: https://sync-or-swim.readthedocs.io/en/latest/modules.html
[4]: https://github.com/python-boltons/cc-python
[5]: https://github.com/cookiecutter/cookiecutter
[6]: https://docs.readthedocs.io/en/stable/
[7]: https://github.com/bbugyi200/sync-or-swim/blob/master/CONTRIBUTING.md
[8]: https://github.com/bbugyi200/sync-or-swim
[9]: https://pip.pypa.io
[10]: http://docs.python-guide.org/en/latest/starting/installation/
[11]: https://github.com/pypa/pipx
[12]: https://github.com/cruft/cruft
[13]: https://github.com/bbugyi200/sync-or-swim/issues/new/choose