| Name | git-backupper JSON |
| Version |
0.3.5
JSON |
| download |
| home_page | |
| Summary | Simplest way to backup and restore git repositories |
| upload_time | 2023-07-09 12:49:45 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
automation
git
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# git-backupper
Simplest way to back up and restore git repositories.
## Installation
You are to have [git](https://git-scm.com) installed on your machine.
Use the package manager [pip](https://pip.pypa.io/en/stable) to install `git-backupper` with the command-line interface:
```bash
python3 -m pip install --user git-backupper
```
## Basic usage
Using this program allows you to mirror your git repositories to a backup location.
> **Warning:**
> Before you begin, it is important to make sure that you have configured git properly and have access to the repositories you want to back up.
> This will ensure that the backup process goes smoothly and your valuable data is protected.
You are to create a configuration file `.git_backupper.json` in your home directory with the following content:
```json
{
"backup_path": "/tmp/backup_repositories",
"repositories": [
"https://github.com/vladpunko/git-backupper.git"
]
}
```
This configuration file specifies the directory where backups will be stored, and the git repositories that will be backed up.
By default, the backups will be stored in a hidden directory called `.backup_repositories` in your home directory.
You can customize the backup directory path by changing the value of the **backup_path** field.
If you want to include additional repositories in the backup list, just append their urls to the **repositories** array.
You can back up and restore your repository with the following commands:
```bash
# Step -- 1.
git-backupper # back up all repositories from the configuration file
# Step -- 2.
cd /tmp/backup_repositories/git-backupper.git
# Step -- 3.
git push --mirror https://github.com/vladpunko/git-backupper.git
```
## Contributing
Pull requests are welcome.
Please open an issue first to discuss what should be changed.
Please make sure to update tests as appropriate.
```bash
# Step -- 1.
python3 -m venv .venv && source ./.venv/bin/activate && pip install pre-commit tox
# Step -- 2.
pre-commit install --config .githooks.yml
# Step -- 3.
tox && tox -e lint
```
## License
[MIT](https://choosealicense.com/licenses/mit)
Raw data
{
"_id": null,
"home_page": "",
"name": "git-backupper",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "automation,git",
"author": "",
"author_email": "Vladislav Punko <iam.vlad.punko@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3d/ad/77e0e4b1f83cfe042b7baaef37b82bf0f9f0079b162e7702c0860dcc8fd3/git-backupper-0.3.5.tar.gz",
"platform": null,
"description": "# git-backupper\n\n\n\nSimplest way to back up and restore git repositories.\n\n\n\n## Installation\n\nYou are to have [git](https://git-scm.com) installed on your machine.\n\nUse the package manager [pip](https://pip.pypa.io/en/stable) to install `git-backupper` with the command-line interface:\n\n```bash\npython3 -m pip install --user git-backupper\n```\n\n## Basic usage\n\nUsing this program allows you to mirror your git repositories to a backup location.\n\n> **Warning:**\n> Before you begin, it is important to make sure that you have configured git properly and have access to the repositories you want to back up.\n> This will ensure that the backup process goes smoothly and your valuable data is protected.\n\nYou are to create a configuration file `.git_backupper.json` in your home directory with the following content:\n\n```json\n{\n \"backup_path\": \"/tmp/backup_repositories\",\n \"repositories\": [\n \"https://github.com/vladpunko/git-backupper.git\"\n ]\n}\n```\n\nThis configuration file specifies the directory where backups will be stored, and the git repositories that will be backed up.\nBy default, the backups will be stored in a hidden directory called `.backup_repositories` in your home directory.\nYou can customize the backup directory path by changing the value of the **backup_path** field.\nIf you want to include additional repositories in the backup list, just append their urls to the **repositories** array.\n\nYou can back up and restore your repository with the following commands:\n\n```bash\n# Step -- 1.\ngit-backupper # back up all repositories from the configuration file\n\n# Step -- 2.\ncd /tmp/backup_repositories/git-backupper.git\n\n# Step -- 3.\ngit push --mirror https://github.com/vladpunko/git-backupper.git\n```\n\n## Contributing\n\nPull requests are welcome.\nPlease open an issue first to discuss what should be changed.\n\nPlease make sure to update tests as appropriate.\n\n```bash\n# Step -- 1.\npython3 -m venv .venv && source ./.venv/bin/activate && pip install pre-commit tox\n\n# Step -- 2.\npre-commit install --config .githooks.yml\n\n# Step -- 3.\ntox && tox -e lint\n```\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simplest way to backup and restore git repositories",
"version": "0.3.5",
"project_urls": {
"Issue tracker": "https://github.com/vladpunko/git-backupper/issues",
"Source code": "https://github.com/vladpunko/git-backupper"
},
"split_keywords": [
"automation",
"git"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ff187a331ca52cf855f6cff3478a8047b791131120746289b4a4e55178ed0cd2",
"md5": "11de924154fe26f990465c9fb510dcf6",
"sha256": "a5626139932421c695589ecd122aa4175016f4e5d54eef75585bc4756bfbc98e"
},
"downloads": -1,
"filename": "git_backupper-0.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "11de924154fe26f990465c9fb510dcf6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13321,
"upload_time": "2023-07-09T12:49:42",
"upload_time_iso_8601": "2023-07-09T12:49:42.060789Z",
"url": "https://files.pythonhosted.org/packages/ff/18/7a331ca52cf855f6cff3478a8047b791131120746289b4a4e55178ed0cd2/git_backupper-0.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3dad77e0e4b1f83cfe042b7baaef37b82bf0f9f0079b162e7702c0860dcc8fd3",
"md5": "e8c57c3c1ecbef5819d1524a8317f903",
"sha256": "3ff5a308acfbfd46890cfeb132001eb9e34e2c05cf4fe47b40cbfd02c74c0a6b"
},
"downloads": -1,
"filename": "git-backupper-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "e8c57c3c1ecbef5819d1524a8317f903",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 447931,
"upload_time": "2023-07-09T12:49:45",
"upload_time_iso_8601": "2023-07-09T12:49:45.576427Z",
"url": "https://files.pythonhosted.org/packages/3d/ad/77e0e4b1f83cfe042b7baaef37b82bf0f9f0079b162e7702c0860dcc8fd3/git-backupper-0.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-09 12:49:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vladpunko",
"github_project": "git-backupper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "git-backupper"
}
