# eez-backup
Another convenience wrapper for [_restic_](https://restic.net/).
## Install
You can simply install `eez-backup` from PyPI via
```bash
python -m pip install eez-backup
```
## Setup
`eez-backup` assumes `backup.yml` to be present in your home directory, thus create it.
You can use [`tests/demo/config.yml`](./tests/demo/config.yml) as a template.
Now, you can initialize the _restic_ repositories by running
```bash
backup repo-map init
```
... and then back up your data by running
```bash
backup run
```
That's it!
## CLI interface
```text
usage: backup [-h] [-v] [-c] [-r] [-p] {run,repo-map,profile-map} ...
Another convenience wrapper for restic
positional arguments:
{run,repo-map,profile-map}
commands
run run backup and forget for all profiles
repo-map run any restic command for all given repositories
profile-map run any restic command for all given profiles
options:
-h, --help show this help message and exit
-v, --verbose log level (disables progress bars if set)
-c , --config config file to use, default is ~/.backup.yml
-r , --repository repository to use, use all repositories by default, can be used multiple times
-p , --profile profile to use, use all profiles by default, can be used multiple times
```
(`backup --help`)
### Glossary
- **Repositories:** refer to a target locations for your backups and map 1:1 to [_restic_ repositories](https://restic.readthedocs.io/en/stable/030_preparing_a_new_repo.html).
- **Profiles:** define a set of directories/files to be in-/excluded from a backup among other options. Per profile and
backup a [snapshot](https://restic.readthedocs.io/en/stable/040_backup.html) is created.
Raw data
{
"_id": null,
"home_page": "https://github.com/0b11001111/eez-backup",
"name": "eez-backup",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "backup,restic",
"author": "0b11001111",
"author_email": "19192307+0b11001111@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/ee/a0/050821d5b7812361274dbb6f1bc89434ff7c02ee67cb4e54366775a220fd/eez_backup-0.2.0.tar.gz",
"platform": null,
"description": "# eez-backup\n\nAnother convenience wrapper for [_restic_](https://restic.net/).\n\n## Install\n\nYou can simply install `eez-backup` from PyPI via\n\n```bash\npython -m pip install eez-backup\n```\n\n## Setup\n\n`eez-backup` assumes `backup.yml` to be present in your home directory, thus create it.\nYou can use [`tests/demo/config.yml`](./tests/demo/config.yml) as a template.\n\nNow, you can initialize the _restic_ repositories by running\n\n```bash\nbackup repo-map init\n```\n\n... and then back up your data by running\n\n```bash\nbackup run\n```\n\nThat's it!\n\n## CLI interface\n\n```text\nusage: backup [-h] [-v] [-c] [-r] [-p] {run,repo-map,profile-map} ...\n\nAnother convenience wrapper for restic\n\npositional arguments:\n {run,repo-map,profile-map}\n commands\n run run backup and forget for all profiles\n repo-map run any restic command for all given repositories\n profile-map run any restic command for all given profiles\n\noptions:\n -h, --help show this help message and exit\n -v, --verbose log level (disables progress bars if set)\n -c , --config config file to use, default is ~/.backup.yml\n -r , --repository repository to use, use all repositories by default, can be used multiple times\n -p , --profile profile to use, use all profiles by default, can be used multiple times\n```\n\n(`backup --help`)\n\n### Glossary\n\n- **Repositories:** refer to a target locations for your backups and map 1:1 to [_restic_ repositories](https://restic.readthedocs.io/en/stable/030_preparing_a_new_repo.html).\n- **Profiles:** define a set of directories/files to be in-/excluded from a backup among other options. Per profile and\n backup a [snapshot](https://restic.readthedocs.io/en/stable/040_backup.html) is created.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Another convenience wrapper for _restic_",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/0b11001111/eez-backup",
"Repository": "https://github.com/0b11001111/eez-backup"
},
"split_keywords": [
"backup",
"restic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d8b02e5c25f9ae986369c6c82b34a643f6bb3c26b787da45931f8d30170c296",
"md5": "d4cfbfb0960e088e856d10d6313d0f30",
"sha256": "23e3835ed615e99b3900b50bda91458d73967c57f1a18f06b31531d0bd78ec98"
},
"downloads": -1,
"filename": "eez_backup-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d4cfbfb0960e088e856d10d6313d0f30",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 10750,
"upload_time": "2023-09-02T21:40:05",
"upload_time_iso_8601": "2023-09-02T21:40:05.266198Z",
"url": "https://files.pythonhosted.org/packages/3d/8b/02e5c25f9ae986369c6c82b34a643f6bb3c26b787da45931f8d30170c296/eez_backup-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eea0050821d5b7812361274dbb6f1bc89434ff7c02ee67cb4e54366775a220fd",
"md5": "22d5ec1315b9d237b6be4a387ea38f5e",
"sha256": "af1af0d49b80f12af6a56f3650cc3b4343f860b4e06955019676c3aaa1adabbc"
},
"downloads": -1,
"filename": "eez_backup-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "22d5ec1315b9d237b6be4a387ea38f5e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 9347,
"upload_time": "2023-09-02T21:40:06",
"upload_time_iso_8601": "2023-09-02T21:40:06.659009Z",
"url": "https://files.pythonhosted.org/packages/ee/a0/050821d5b7812361274dbb6f1bc89434ff7c02ee67cb4e54366775a220fd/eez_backup-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-02 21:40:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "0b11001111",
"github_project": "eez-backup",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "eez-backup"
}
JSON
