# github-backup-tool
BIG NOTE: This is a work-in-progress.
A crunchy tool for backing up repositories of multiple specified GitHub organizations.
## What does it do?
It will backup all Git repositories it has access to.
## What does it not do?
At this moment, it will not back up:
* Issues
* Comments
* Hooks
* ...
*Eventually*, backing up of these will be implemented.
## How to use?
1. Set up a GitHub token, with a "repo" scope.
2. Configure the `config.yaml` file accordingly.
3. Set up your running environment either via a virtualenv or distribution packages:
* virtualenv:
* Create a Python virtual environment via `virtualenv venv`
* Activate your `venv` via `source venv/bin/activate` (Consider the shell you are using, and adjuct this step accrodingly.)
* Install via `pip install github-backup-tool`
* distribution packages:
* [GitPython](https://github.com/gitpython-developers/GitPython), [GitPython@Repology](https://repology.org/project/python:gitpython/versions)
* [PyGithub](https://github.com/PyGithub/PyGithub), [PyGithub@Repology](https://repology.org/project/python:pygithub/versions)
* [PyYAML](https://pyyaml.org/), [PyYAML@Repology](https://repology.org/project/python:pyyaml/versions)
4. Run `gbt -c yourconfig.yaml`.
# TODOs:
- [x] Backup abandoned commits in master as a separate branch if commits were pushed to origin forcefully
- [ ] Backup issues
- [ ] Backup hooks
- [ ] Backup information of users, belonging to an organization
- [ ] Configuration: allow for ignoring of certain repositories
- [ ] Brainstorm about more ideas as to what to back up
Raw data
{
"_id": null,
"home_page": "https://github.com/bitsbeats/github-backup-tool",
"name": "github-backup-tool",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "thomann.io",
"author_email": "python@thomann.io",
"download_url": "https://files.pythonhosted.org/packages/e4/dc/e208fe71fe8f99fbfcbc5c92ae54b3617c9ef1dbc2a8cf6e79b0a6c183f1/github-backup-tool-0.0.5.tar.gz",
"platform": null,
"description": "# github-backup-tool\n\nBIG NOTE: This is a work-in-progress.\n\nA crunchy tool for backing up repositories of multiple specified GitHub organizations.\n\n## What does it do?\nIt will backup all Git repositories it has access to.\n\n## What does it not do?\nAt this moment, it will not back up:\n* Issues\n* Comments\n* Hooks\n* ...\n\n*Eventually*, backing up of these will be implemented.\n\n## How to use?\n\n1. Set up a GitHub token, with a \"repo\" scope.\n2. Configure the `config.yaml` file accordingly.\n3. Set up your running environment either via a virtualenv or distribution packages:\n * virtualenv:\n * Create a Python virtual environment via `virtualenv venv`\n * Activate your `venv` via `source venv/bin/activate` (Consider the shell you are using, and adjuct this step accrodingly.)\n * Install via `pip install github-backup-tool`\n * distribution packages:\n * [GitPython](https://github.com/gitpython-developers/GitPython), [GitPython@Repology](https://repology.org/project/python:gitpython/versions)\n * [PyGithub](https://github.com/PyGithub/PyGithub), [PyGithub@Repology](https://repology.org/project/python:pygithub/versions)\n * [PyYAML](https://pyyaml.org/), [PyYAML@Repology](https://repology.org/project/python:pyyaml/versions)\n4. Run `gbt -c yourconfig.yaml`.\n\n# TODOs:\n- [x] Backup abandoned commits in master as a separate branch if commits were pushed to origin forcefully\n- [ ] Backup issues\n- [ ] Backup hooks\n- [ ] Backup information of users, belonging to an organization\n- [ ] Configuration: allow for ignoring of certain repositories\n- [ ] Brainstorm about more ideas as to what to back up\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A tool for backing up repositories from GitHub organizations",
"version": "0.0.5",
"project_urls": {
"Bug Tracker": "https://github.com/bitsbeats/github-backup-tool/issues",
"Homepage": "https://github.com/bitsbeats/github-backup-tool"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4c8d1194f687f631848b1861d545d59f800c9b7128575ea45d9287074a15946a",
"md5": "9932f5782de61bdf614ea1c263c8a186",
"sha256": "cc12777f08c6684dc9bdb64ecf40f07ac5042cf4a9e2da32ec7b21c74ef268d6"
},
"downloads": -1,
"filename": "github_backup_tool-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9932f5782de61bdf614ea1c263c8a186",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 14486,
"upload_time": "2024-01-17T12:28:30",
"upload_time_iso_8601": "2024-01-17T12:28:30.634633Z",
"url": "https://files.pythonhosted.org/packages/4c/8d/1194f687f631848b1861d545d59f800c9b7128575ea45d9287074a15946a/github_backup_tool-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e4dce208fe71fe8f99fbfcbc5c92ae54b3617c9ef1dbc2a8cf6e79b0a6c183f1",
"md5": "ad4150b4b5077864adc86bea361b197a",
"sha256": "899bafed26146e293356f7a24df04e405309d6dc96acb2daaeaed06408d99503"
},
"downloads": -1,
"filename": "github-backup-tool-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "ad4150b4b5077864adc86bea361b197a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 13050,
"upload_time": "2024-01-17T12:28:32",
"upload_time_iso_8601": "2024-01-17T12:28:32.415190Z",
"url": "https://files.pythonhosted.org/packages/e4/dc/e208fe71fe8f99fbfcbc5c92ae54b3617c9ef1dbc2a8cf6e79b0a6c183f1/github-backup-tool-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-17 12:28:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bitsbeats",
"github_project": "github-backup-tool",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "GitPython",
"specs": [
[
"==",
"3.1.20"
]
]
},
{
"name": "humanize",
"specs": [
[
"==",
"3.14.0"
]
]
},
{
"name": "PyGithub",
"specs": [
[
"==",
"1.55"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"==",
"6.0"
]
]
},
{
"name": "SQLAlchemy",
"specs": [
[
"==",
"1.4.37"
]
]
}
],
"lcname": "github-backup-tool"
}
JSON
