{"id":18598173,"url":"https://github.com/bbugyi200/sync-or-swim","last_synced_at":"2026-04-25T21:32:22.630Z","repository":{"id":59568141,"uuid":"537942357","full_name":"bbugyi200/sync-or-swim","owner":"bbugyi200","description":"Sync data files across all of your machines (tinyurl.com/sync-or-swim)","archived":false,"fork":false,"pushed_at":"2022-09-18T20:05:02.000Z","size":42,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-21T05:42:25.086Z","etag":null,"topics":["cc-python","python"],"latest_commit_sha":null,"homepage":"https://sync-or-swim.readthedocs.io/en/latest","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bbugyi200.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2022-09-17T22:13:56.000Z","updated_at":"2022-09-19T14:48:40.000Z","dependencies_parsed_at":"2022-09-19T02:42:05.789Z","dependency_job_id":null,"html_url":"https://github.com/bbugyi200/sync-or-swim","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbugyi200%2Fsync-or-swim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbugyi200%2Fsync-or-swim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbugyi200%2Fsync-or-swim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbugyi200%2Fsync-or-swim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bbugyi200","download_url":"https://codeload.github.com/bbugyi200/sync-or-swim/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254544159,"owners_count":22088808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cc-python","python"],"created_at":"2024-11-07T01:31:22.360Z","updated_at":"2026-04-25T21:32:17.611Z","avatar_url":"https://github.com/bbugyi200.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sync_or_swim\n\n**Sync your data files across all of your machines (tinyurl.com/sync-or-swim)**\n\n_project status badges:_\n\n[![CI Workflow](https://github.com/bbugyi200/sync-or-swim/actions/workflows/ci.yml/badge.svg)](https://github.com/bbugyi200/sync-or-swim/actions/workflows/ci.yml)\n[![Coverage](https://codecov.io/gh/bbugyi200/sync-or-swim/branch/master/graph/badge.svg)](https://codecov.io/gh/bbugyi200/sync-or-swim)\n[![Documentation Status](https://readthedocs.org/projects/sync-or-swim/badge/?version=latest)](https://sync-or-swim.readthedocs.io/en/latest/?badge=latest)\n[![Package Health](https://snyk.io/advisor/python/sync-or-swim/badge.svg)](https://snyk.io/advisor/python/sync-or-swim)\n\n_version badges:_\n\n[![Project Version](https://img.shields.io/pypi/v/sync-or-swim)](https://pypi.org/project/sync-or-swim/)\n[![Python Versions](https://img.shields.io/pypi/pyversions/sync-or-swim)](https://pypi.org/project/sync-or-swim/)\n[![Cookiecutter: cc-python](https://img.shields.io/static/v1?label=cc-python\u0026message=2022.01.04\u0026color=d4aa00\u0026logo=cookiecutter\u0026logoColor=d4aa00)](https://github.com/python-boltons/cc-python)\n[![Docker: pythonboltons/main](https://img.shields.io/static/v1?label=pythonboltons%20%2F%20main\u0026message=2021.12.22\u0026color=8ec4ad\u0026logo=docker\u0026logoColor=8ec4ad)](https://github.com/python-boltons/docker-python)\n\n\n## Installation 🗹\n\n### Using `pipx` to Install (preferred)\n\nThis package _could_ be installed using pip like any other Python package (in\nfact, see the section below this one for instructions on how to do just that).\nGiven that we only need this package's entry points, however, we recommend that\n[pipx][11] be used instead:\n\n```shell\n# install and setup pipx\npython3 -m pip install --user pipx\npython3 -m pipx ensurepath\n\n# install sync_or_swim\npipx install sync-or-swim\n```\n\n### Using `pip` to Install\n\nTo install `sync_or_swim` using [pip][9], run the following\ncommands in your terminal:\n\n``` shell\npython3 -m pip install --user sync-or-swim  # install sync_or_swim\n```\n\nIf you don't have pip installed, this [Python installation guide][10] can guide\nyou through the process.\n\n\n## Command-Line Interface (CLI)\n\nThe output from running `sync_or_swim --help` is shown below:\n\n\u003c!-- [[[[[kooky.cog\nimport subprocess\n\npopen = subprocess.Popen([\"sync_or_swim\", \"--help\"], stdout=subprocess.PIPE)\nstdout, _ = popen.communicate()\nprint(\"```\", stdout.decode().strip(), \"```\", sep=\"\\n\")\n]]]]] --\u003e\n```\nusage: sync_or_swim [-h] [-c CONFIG_FILE] [-L [FILE[:LEVEL][@FORMAT]]] [-v]\n                    [--version]\n\nContains the sync_or_swim package's main entry point.\n\noptional arguments:\n  -c CONFIG_FILE, --config CONFIG_FILE\n                        Absolute or relative path to a YAML file that contains\n                        this application's configuration.\n  -h, --help            show this help message and exit\n  -L [FILE[:LEVEL][@FORMAT]], --log [FILE[:LEVEL][@FORMAT]]\n                        This option can be used to enable a new logging\n                        handler. FILE should be either a path to a logfile or\n                        one of the following special file types: [1] 'stderr'\n                        to log to standard error (enabled by default), [2]\n                        'stdout' to log to standard out, [3] 'null' to disable\n                        all console (e.g. stderr) handlers, or [4] '+[NAME]'\n                        to choose a default logfile path (where NAME is an\n                        optional basename for the logfile). LEVEL can be any\n                        valid log level (i.e. one of ['CRITICAL', 'DEBUG',\n                        'ERROR', 'INFO', 'TRACE', 'WARNING']) and FORMAT can\n                        be any valid log format (i.e. one of ['color', 'json',\n                        'nocolor']). NOTE: This option can be specified\n                        multiple times and has a default argument of '+'.\n  -v, --verbose         How verbose should the output be? This option can be\n                        specified multiple times (e.g. -v, -vv, -vvv, ...).\n  --version             show program's version number and exit\n```\n\u003c!-- [[[[[end]]]]] --\u003e\n\n\u003c!-- [[[[[kooky.cog\nfrom pathlib import Path\n\nlines = Path(\"./docs/design/design.md\").read_text().split(\"\\n\")\nif any(L.strip() for L in lines):\n    fixed_lines = [L.replace(\"(.\", \"(./docs/design\") if L.startswith(\"![\") else L for L in lines]\n    print(\"## Design Diagrams\\n\")\n    print(\"\\n\".join(fixed_lines))\n]]]]] --\u003e\n\u003c!-- [[[[[end]]]]] --\u003e\n\n\n## Useful Links 🔗\n\n* [API Reference][3]: A developer's reference of the API exposed by this\n  project.\n* [cc-python][4]: The [cookiecutter][5] that was used to generate this project.\n  Changes made to this cookiecutter are periodically synced with this project\n  using [cruft][12].\n* [CHANGELOG.md][2]: We use this file to document all notable changes made to\n  this project.\n* [CONTRIBUTING.md][7]: This document contains guidelines for developers\n  interested in contributing to this project.\n* [Create a New Issue][13]: Create a new GitHub issue for this project.\n* [Documentation][1]: This project's full documentation.\n\n\n[1]: https://sync-or-swim.readthedocs.io/en/latest\n[2]: https://github.com/bbugyi200/sync-or-swim/blob/master/CHANGELOG.md\n[3]: https://sync-or-swim.readthedocs.io/en/latest/modules.html\n[4]: https://github.com/python-boltons/cc-python\n[5]: https://github.com/cookiecutter/cookiecutter\n[6]: https://docs.readthedocs.io/en/stable/\n[7]: https://github.com/bbugyi200/sync-or-swim/blob/master/CONTRIBUTING.md\n[8]: https://github.com/bbugyi200/sync-or-swim\n[9]: https://pip.pypa.io\n[10]: http://docs.python-guide.org/en/latest/starting/installation/\n[11]: https://github.com/pypa/pipx\n[12]: https://github.com/cruft/cruft\n[13]: https://github.com/bbugyi200/sync-or-swim/issues/new/choose\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbugyi200%2Fsync-or-swim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbbugyi200%2Fsync-or-swim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbugyi200%2Fsync-or-swim/lists"}