{"id":15917486,"url":"https://github.com/takuya/python_rclone_backup","last_synced_at":"2025-10-29T13:14:18.802Z","repository":{"id":136551547,"uuid":"463859451","full_name":"takuya/python_rclone_backup","owner":"takuya","description":"python_rclone_backup","archived":false,"fork":false,"pushed_at":"2022-04-18T03:49:07.000Z","size":20,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-09T01:13:53.096Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/takuya.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-26T13:23:35.000Z","updated_at":"2024-04-25T01:01:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"fe79a702-e9f8-4d02-b798-5661c6e734da","html_url":"https://github.com/takuya/python_rclone_backup","commit_stats":{"total_commits":8,"total_committers":1,"mean_commits":8.0,"dds":0.0,"last_synced_commit":"f95051e28e212ab3ad2427b894f8f0bd55781efe"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takuya%2Fpython_rclone_backup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takuya%2Fpython_rclone_backup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takuya%2Fpython_rclone_backup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takuya%2Fpython_rclone_backup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/takuya","download_url":"https://codeload.github.com/takuya/python_rclone_backup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246998098,"owners_count":20866690,"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":[],"created_at":"2024-10-06T18:10:56.980Z","updated_at":"2025-10-29T13:14:13.776Z","avatar_url":"https://github.com/takuya.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# python_rclone_backup\n\npython_rclone_backup\n\n## install \n\nsample, install by pip from github.\n```shell\npip install git+https://github.com/takuya/python_rclone_backup.git#egg=rclone_backup\n```\n\nusing pyenv and pipenv \n```shell\npyenv local 3.9.8\npyenv exec pipenv install --python=3.9.8\npyenv exec pipenv install git+https://github.com/takuya/python_rclone_backup.git#egg=rclone_backup\npyenv exec pipenv install \n```\n\n## for rclone backup\n\n- pre/post scripts\n- Archiving \n- pipe \n- config\n\nWe know `rclone` is great. but backup come with messy procedure.\n\nThis will make archiving more simple. add pipe, with `post backup` / `pre backup` commands to maintain.\n### pre/post scripts\n\nfor achive , pre/post scripts.\n\n### Archiving and Pipe\n\ntar for archive , adding `archive` option alternatively to use `rclone sync`.\n```python\n['./backup', 'my-remote:/archive-test.tgz', 'archive'],\n```\n\npipe for archive , adding `pipe` option alternatively to use `rclone sync`.\n\n```python\n['mysqldump | gzip -c - ', 'my-remote:/mysqldump.sql.gz', 'pipe'],\n```\n\n### backup config\n\nconfig using dict / list, for reducing shell script.\n\n### config example\n\n```python\nimport os\nimport sys\nimport rclone_backup\n\nproject_root = os.path.realpath(os.path.dirname(os.path.realpath(__file__)) + \"/..\")\nsys.path.insert(0, project_root)\nfrom rclone_backup.Backup import Backup\n\n\ndef main():\n    config = {\n        'pre_backup':  {\n            \"stop service\": \"sudo systemctl stop xxx.service\"\n        },\n        'backup_pair': [\n            ['./backup/Backup.py', 'my-remote:/', 'copy'],\n            ['./backup', 'my-remote:/archive-test.tgz', 'archive'],\n            ['apt list --installed | gzip -c - ', 'my-remote:/apt-list.gz', 'pipe'],\n        ],\n        'post_backup': {\n            \"start service\": \"sudo systemctl start xxx.service\"\n        },\n    }\n    rclone_config = \"~/.rclone.conf\"\n    rclone_opts = [\n        '--links',\n        '-q',\n    ]\n    bk = Backup(rclone_config, rclone_opts, dry_run=(os.environ.get('dry_run') or False))\n    bk.add_backup_list(config['backup_pair'])\n    bk.add_pre_backup_cmd(config[\"pre_backup\"])\n    bk.add_post_backup_cmd(config[\"post_backup\"])\n    bk.start(verbose=(os.environ.get('verbose') or False))\n\n\nif __name__ == '__main__':\n    main()\n\nmain()\n\n```\n\nThis will execute these shell commands.\n\n```shell\nsudo systemctl stop xxx.service\nsudo tar cvzf /var/www www.tgz\nrclone --config ~/.rclone.conf --links copy ./backup/Backup.py my-remote:/Backup.py\ntar czf - ./backup | rclone --config ~/.rclone.conf --links rcat  my-remote:/archive-test.tgz\napt list --installed | gzip -c -  | rclone --config ~/.rclone.conf --links rcat  my-remote:/apt-list.gz\nsudo systemctl start xxx.service\n```\n\n## mysqldump sample : pipe\n\nmysqldump pipe to rclone\n\n```python\nimport os\nfrom rclone_backup.Backup import Backup\n\ndb_host, db_user, db_pass, db_name = ['localhost', 'mysql', 'password', 'db_name']\n\nconfig = {\n  'backup_pair':[\n    [f'mysqldump --single-transaction -h {db_host} -u {db_user} --password={db_pass} {db_name}'\n     '| gzip -',\n     'my-remote:/mysqldump.gz', 'pipe'],\n   ]\n}\n\n\n\ndef main():\n    bk = Backup(dry_run=(os.environ.get('dry_run') or False))\n    bk.add_backup_list(config['backup_pair'])\n    bk.start(verbose=(os.environ.get('verbose') or False))\n\n\nif __name__ == '__main__':\n    main()\n\nmain()\n\n```\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftakuya%2Fpython_rclone_backup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftakuya%2Fpython_rclone_backup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftakuya%2Fpython_rclone_backup/lists"}