| Name | dotbackup JSON |
| Version |
1.2.0
JSON |
| download |
| home_page | None |
| Summary | YAML config based backup utility. Easy to use yet flexible. With a primary focus on dotfile backup & setup, but not limited to dotfiles. |
| upload_time | 2024-04-07 12:39:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
yaml
backup
dotfiles
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
ruamel.yaml
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# dotbackup
[](https://pypi.org/project/dotbackup)
[](https://pypi.org/project/dotbackup)
[](https://aur.archlinux.org/packages/dotbackup)
[](https://github.com/psf/black)
[](https://github.com/PyCQA/flake8)
[](https://pycqa.github.io/isort)
[](https://pytest.org)
[](https://codecov.io/gh/jaxvanyang/dotbackup)
Usually people maintain backup and setup scripts along with their dotfiles. But
these scripts always contain a lot of repeat codes, and writing them is not fun!
`dotbackup` and `dotsetup` are here to help.
With these two tools, you only need to write a simple configuration and they
will know how to back up and set up your dotfiles. You can read [dotbackup(1)](dotbackup.1.adoc)
and [dotsetup(1)](dotsetup.1.adoc) for details.
## Highlights
- Simple configuration.
- Custom hooks.
- Detailed logs.
## Installation
You can install from one of these package managers:
- [PyPI](https://pypi.org/project/dotbackup)
- [AUR](https://aur.archlinux.org/packages/dotbackup)
Installing from a package manager gives you the two commands - `dotbackup` and
`dotsetup`, and the manpages. But you can also download this single script:
[dotbackup.py](./src/dotbackup.py). In fact, `dotbackup` and `dotsetup` are just
shortcut commands of `dotbackup.py`, which means that `dotbackup` is equivalent
to `dotbackup.py backup` and `dotsetup` is equivalent to `dotbackup.py setup`.
## Quick Start
Write a simple configuration and place it to `~/.config/dotbackup/dotbackup.yml`:
```yml
backup_dir: ~/backup
apps:
vim:
files: [~/.vimrc]
nvim:
files:
- ~/.config/nvim/init.lua
- ~/.config/nvim/lua
```
Do backup:
```console
$ dotbackup
INFO: doing vim backup...
INFO: copying ~/.vimrc to /home/user/backup/.vimrc...
INFO: doing nvim backup...
INFO: copying ~/.config/nvim/init.lua to /home/user/backup/.config/nvim/init.lua...
INFO: copying ~/.config/nvim/lua to /home/user/backup/.config/nvim/lua...
```
Do setup:
```console
$ dotsetup
INFO: doing vim setup...
INFO: copying /home/user/backup/.vimrc to /home/user/.vimrc...
INFO: doing nvim setup...
INFO: copying /home/user/backup/.config/nvim/init.lua to /home/user/.config/nvim/init.lua...
INFO: copying /home/user/backup/.config/nvim/lua to /home/user/.config/nvim/lua...
```
## Documentation
For more information, please read [dotbackup(1)](dotbackup.1.adoc) and [dotsetup(1)](dotsetup.1.adoc).
Raw data
{
"_id": null,
"home_page": null,
"name": "dotbackup",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "YAML, backup, dotfiles",
"author": null,
"author_email": "Jax Young <jaxvanyang@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/af/6c/41176b61abf00a40736e9719e175de6515fc6d60b76d1536e6eaa8091c8f/dotbackup-1.2.0.tar.gz",
"platform": null,
"description": "# dotbackup\n\n\n[](https://pypi.org/project/dotbackup)\n[](https://pypi.org/project/dotbackup)\n[](https://aur.archlinux.org/packages/dotbackup)\n\n[](https://github.com/psf/black)\n[](https://github.com/PyCQA/flake8)\n[](https://pycqa.github.io/isort)\n[](https://pytest.org)\n[](https://codecov.io/gh/jaxvanyang/dotbackup)\n\nUsually people maintain backup and setup scripts along with their dotfiles. But\nthese scripts always contain a lot of repeat codes, and writing them is not fun!\n`dotbackup` and `dotsetup` are here to help.\n\nWith these two tools, you only need to write a simple configuration and they\nwill know how to back up and set up your dotfiles. You can read [dotbackup(1)](dotbackup.1.adoc)\nand [dotsetup(1)](dotsetup.1.adoc) for details.\n\n## Highlights\n\n- Simple configuration.\n- Custom hooks.\n- Detailed logs.\n\n## Installation\n\nYou can install from one of these package managers:\n\n- [PyPI](https://pypi.org/project/dotbackup)\n- [AUR](https://aur.archlinux.org/packages/dotbackup)\n\nInstalling from a package manager gives you the two commands - `dotbackup` and\n`dotsetup`, and the manpages. But you can also download this single script:\n[dotbackup.py](./src/dotbackup.py). In fact, `dotbackup` and `dotsetup` are just\nshortcut commands of `dotbackup.py`, which means that `dotbackup` is equivalent\nto `dotbackup.py backup` and `dotsetup` is equivalent to `dotbackup.py setup`.\n\n## Quick Start\n\nWrite a simple configuration and place it to `~/.config/dotbackup/dotbackup.yml`:\n\n```yml\nbackup_dir: ~/backup\napps:\n vim:\n files: [~/.vimrc]\n nvim:\n files:\n - ~/.config/nvim/init.lua\n - ~/.config/nvim/lua\n```\n\nDo backup:\n\n```console\n$ dotbackup\nINFO: doing vim backup...\nINFO: copying ~/.vimrc to /home/user/backup/.vimrc...\nINFO: doing nvim backup...\nINFO: copying ~/.config/nvim/init.lua to /home/user/backup/.config/nvim/init.lua...\nINFO: copying ~/.config/nvim/lua to /home/user/backup/.config/nvim/lua...\n```\n\nDo setup:\n\n```console\n$ dotsetup\nINFO: doing vim setup...\nINFO: copying /home/user/backup/.vimrc to /home/user/.vimrc...\nINFO: doing nvim setup...\nINFO: copying /home/user/backup/.config/nvim/init.lua to /home/user/.config/nvim/init.lua...\nINFO: copying /home/user/backup/.config/nvim/lua to /home/user/.config/nvim/lua...\n```\n\n## Documentation\n\nFor more information, please read [dotbackup(1)](dotbackup.1.adoc) and [dotsetup(1)](dotsetup.1.adoc).\n",
"bugtrack_url": null,
"license": null,
"summary": "YAML config based backup utility. Easy to use yet flexible. With a primary focus on dotfile backup & setup, but not limited to dotfiles.",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/jaxvanyang/dotbackup",
"Issues": "https://github.com/jaxvanyang/dotbackup/issues",
"Repository": "https://github.com/jaxvanyang/dotbackup.git",
"Source": "https://github.com/jaxvanyang/dotbackup"
},
"split_keywords": [
"yaml",
" backup",
" dotfiles"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "940ea9b28bcea5f3be1b7c439e34409f5810be09e98b5cfa68eff6ab4c1e9286",
"md5": "ba4216d679f8f941473bc5536cb1882d",
"sha256": "bccd400807a224fab4e0acb75219f09d539a1dc3eacf1eb7cd682792320030bd"
},
"downloads": -1,
"filename": "dotbackup-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba4216d679f8f941473bc5536cb1882d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11375,
"upload_time": "2024-04-07T12:39:17",
"upload_time_iso_8601": "2024-04-07T12:39:17.725571Z",
"url": "https://files.pythonhosted.org/packages/94/0e/a9b28bcea5f3be1b7c439e34409f5810be09e98b5cfa68eff6ab4c1e9286/dotbackup-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "af6c41176b61abf00a40736e9719e175de6515fc6d60b76d1536e6eaa8091c8f",
"md5": "eadca5cb570c88546254e8919f706dbd",
"sha256": "264f6e136a36b7696e8a9b6671a0222fd16d6c2c0a3c604442970c388b19e424"
},
"downloads": -1,
"filename": "dotbackup-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "eadca5cb570c88546254e8919f706dbd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13487,
"upload_time": "2024-04-07T12:39:19",
"upload_time_iso_8601": "2024-04-07T12:39:19.267292Z",
"url": "https://files.pythonhosted.org/packages/af/6c/41176b61abf00a40736e9719e175de6515fc6d60b76d1536e6eaa8091c8f/dotbackup-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-07 12:39:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jaxvanyang",
"github_project": "dotbackup",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "ruamel.yaml",
"specs": []
}
],
"lcname": "dotbackup"
}
