restic-profile-cli 0.2.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- restic_profile/__init__.py +6 -0
- restic_profile/__main__.py +4 -0
- restic_profile/cli.py +204 -0
- restic_profile/config.py +334 -0
- restic_profile/notify.py +513 -0
- restic_profile/runner.py +711 -0
- restic_profile/templates/notify_failure.md.j2 +6 -0
- restic_profile/templates/notify_success.md.j2 +45 -0
- restic_profile_cli-0.2.0.dist-info/METADATA +90 -0
- restic_profile_cli-0.2.0.dist-info/RECORD +13 -0
- restic_profile_cli-0.2.0.dist-info/WHEEL +4 -0
- restic_profile_cli-0.2.0.dist-info/entry_points.txt +2 -0
- restic_profile_cli-0.2.0.dist-info/licenses/LICENSE +18 -0
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
### restic Backup Succeeded
|
|
2
|
+
|
|
3
|
+
- Host: {{ host }}
|
|
4
|
+
- Snapshot: {{ short_id }} @ {{ time }}
|
|
5
|
+
- Profile: {{ profile }}
|
|
6
|
+
{% if tags %}
|
|
7
|
+
- Tags: {{ tags | join(', ') }}
|
|
8
|
+
{% endif %}
|
|
9
|
+
{% if paths %}
|
|
10
|
+
- Paths: {{ paths | join(', ') }}
|
|
11
|
+
{% endif %}
|
|
12
|
+
|
|
13
|
+
### Statistics
|
|
14
|
+
|
|
15
|
+
- Data Added: {{ data_added }}
|
|
16
|
+
{% if duration %}
|
|
17
|
+
- Duration: {{ duration }}
|
|
18
|
+
{% endif %}
|
|
19
|
+
{% if diff_has_parent %}
|
|
20
|
+
|
|
21
|
+
### Changes
|
|
22
|
+
|
|
23
|
+
> +{{ diff_added_files }} files, +{{ diff_added_dirs }} dirs ({{ diff_added_bytes }}) -{{ diff_removed_files }} files, -{{ diff_removed_dirs }} dirs ({{ diff_removed_bytes }})
|
|
24
|
+
{% if diff_changed_files %}
|
|
25
|
+
> {{ diff_changed_files }} changed
|
|
26
|
+
{% endif %}
|
|
27
|
+
{% if diff_changes %}
|
|
28
|
+
|
|
29
|
+
{% for modifier, path in diff_changes %}
|
|
30
|
+
- `{{ modifier }}` {{ path }}
|
|
31
|
+
{% endfor %}
|
|
32
|
+
{% endif %}
|
|
33
|
+
{% endif %}
|
|
34
|
+
|
|
35
|
+
### Repository
|
|
36
|
+
|
|
37
|
+
- {{ repo_snapshots_count }} snapshots · {{ repo_total_size }}
|
|
38
|
+
{% if largest_files %}
|
|
39
|
+
|
|
40
|
+
### Largest Files
|
|
41
|
+
|
|
42
|
+
{% for name, size in largest_files %}
|
|
43
|
+
- {{ name }} {{ size }}
|
|
44
|
+
{% endfor %}
|
|
45
|
+
{% endif %}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: restic-profile-cli
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: Profile-based restic wrapper with Ansible deployment support
|
|
5
|
+
Project-URL: Homepage, https://github.com/ak1ra-lab/restic-profile
|
|
6
|
+
Project-URL: Repository, https://github.com/ak1ra-lab/restic-profile
|
|
7
|
+
Project-URL: Documentation, https://ak1ra-lab.github.io/restic-profile/
|
|
8
|
+
Author-email: ak1ra <git@ak1ra.xyz>
|
|
9
|
+
License-Expression: MIT
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: ansible,backup,restic
|
|
12
|
+
Classifier: Development Status :: 4 - Beta
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Requires-Python: >=3.11
|
|
19
|
+
Requires-Dist: argcomplete>=3.7.0
|
|
20
|
+
Requires-Dist: chaos-utils>=0.5.0
|
|
21
|
+
Requires-Dist: jinja2>=3.1.2
|
|
22
|
+
Requires-Dist: pydantic>=2.13.3
|
|
23
|
+
Description-Content-Type: text/markdown
|
|
24
|
+
|
|
25
|
+
# restic-profile
|
|
26
|
+
|
|
27
|
+
[](https://github.com/ak1ra-lab/restic-profile/actions/workflows/publish-to-pypi.yaml)
|
|
28
|
+
[](https://pypi.org/project/restic-profile-cli/)
|
|
29
|
+
[](https://test.pypi.org/project/restic-profile-cli/)
|
|
30
|
+
[](https://ak1ra-lab.github.io/restic-profile/)
|
|
31
|
+
|
|
32
|
+
Profile-based restic wrapper with Ansible deployment support.
|
|
33
|
+
|
|
34
|
+
Repository for the `restic-profile` Python CLI plus Ansible roles for
|
|
35
|
+
`restic-profile` and `restic-rest-server` deployments.
|
|
36
|
+
|
|
37
|
+
## Installation
|
|
38
|
+
|
|
39
|
+
```shell
|
|
40
|
+
uv sync --group dev
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Optional Ansible Tooling
|
|
44
|
+
|
|
45
|
+
For Ansible role work, install the toolchain once at user level:
|
|
46
|
+
|
|
47
|
+
```shell
|
|
48
|
+
uv tool install ansible-dev-tools --with ansible \
|
|
49
|
+
--with-executables-from ansible-builder,ansible-core,ansible-creator,ansible-dev-environment,ansible-lint,ansible-navigator,ansible-sign,molecule
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Routine Ansible validation currently uses `ansible-lint`. Molecule scenarios remain in the repository as dormant assets and are not part of the supported validation loop.
|
|
53
|
+
|
|
54
|
+
If you use `roles/go_build` or the playbooks under `playbooks/go_build/`, the
|
|
55
|
+
control node also needs a working `go` toolchain in `PATH`.
|
|
56
|
+
|
|
57
|
+
## Repository Development Workflow
|
|
58
|
+
|
|
59
|
+
Clone collections into the `ansible_collections/ak1ra_lab/` namespace layout:
|
|
60
|
+
|
|
61
|
+
```shell
|
|
62
|
+
mkdir -p ~/code/github.com/ansible/collections/ansible_collections/ak1ra_lab
|
|
63
|
+
git clone https://github.com/ak1ra-lab/ansible-collection-general.git \
|
|
64
|
+
~/code/github.com/ansible/collections/ansible_collections/ak1ra_lab/general
|
|
65
|
+
git clone https://github.com/ak1ra-lab/restic-profile.git \
|
|
66
|
+
~/code/github.com/ansible/collections/ansible_collections/ak1ra_lab/restic_profile
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Usage
|
|
70
|
+
|
|
71
|
+
```shell
|
|
72
|
+
uv run restic-profile --help
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
For Ansible-managed backup servers, see the `restic_rest_server` role and the
|
|
76
|
+
documentation under `docs/restic-rest-server/`.
|
|
77
|
+
|
|
78
|
+
## Development
|
|
79
|
+
|
|
80
|
+
```shell
|
|
81
|
+
just lint
|
|
82
|
+
just typecheck
|
|
83
|
+
just test
|
|
84
|
+
just docs-build
|
|
85
|
+
ansible-lint
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Documentation
|
|
89
|
+
|
|
90
|
+
The published documentation site lives at <https://ak1ra-lab.github.io/restic-profile/>, and local docs configuration is stored in `zensical.toml`.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
restic_profile/__init__.py,sha256=mIqxLR4ItcQDgNDGCcXbC-cZuqtXOhRgXCtHCTSmxyM,170
|
|
2
|
+
restic_profile/__main__.py,sha256=nRb3i8BqpOPYzXAeR5fHvSipSlC57sXpqTjYS_xb8go,75
|
|
3
|
+
restic_profile/cli.py,sha256=MSuYA3BUGbr8Mb2uzDZtHWMooYDRFAKZacMyW2leP08,5725
|
|
4
|
+
restic_profile/config.py,sha256=UCtSKo8kF3H49yk84l7KyiHBJygt7wd6rMjxI4mih_c,10687
|
|
5
|
+
restic_profile/notify.py,sha256=nb1ugUKW6CwuDqJSG0Ai4PFxC4pK7q8UJ6zyuaq6iGs,13821
|
|
6
|
+
restic_profile/runner.py,sha256=CKJ_DnU1sjM4bb02ss4LXkANmkfS4iiYKgQkW9BZRVY,22858
|
|
7
|
+
restic_profile/templates/notify_failure.md.j2,sha256=iLpbSO_gBsdrAY_AK5PavwOPsk86xRw9dGTtrvVsC5k,124
|
|
8
|
+
restic_profile/templates/notify_success.md.j2,sha256=vfKiJcfUZfzX3VBtHc9gQMkb2t67uVYf2i5iiukIeEc,975
|
|
9
|
+
restic_profile_cli-0.2.0.dist-info/METADATA,sha256=1A3F_uCwmixWABy0JLYoz-AOPKjVceZjIrGksnLvnwo,3404
|
|
10
|
+
restic_profile_cli-0.2.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
|
|
11
|
+
restic_profile_cli-0.2.0.dist-info/entry_points.txt,sha256=V_Opb1N5yxh5xsM_rAuomFG4AuCERZ5dEuWpP0Ar8wk,59
|
|
12
|
+
restic_profile_cli-0.2.0.dist-info/licenses/LICENSE,sha256=5wVTThekzMrX0upDlmqyR8l5ouE2kBXqbs4xuYt18XM,1062
|
|
13
|
+
restic_profile_cli-0.2.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ak1ra
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
|
6
|
+
associated documentation files (the "Software"), to deal in the Software without restriction, including
|
|
7
|
+
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
8
|
+
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
|
|
9
|
+
following conditions:
|
|
10
|
+
|
|
11
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial
|
|
12
|
+
portions of the Software.
|
|
13
|
+
|
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
|
15
|
+
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
|
|
16
|
+
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
17
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
|
|
18
|
+
USE OR OTHER DEALINGS IN THE SOFTWARE.
|