https://github.com/altaris/qrestic
A simple GUI for restic
https://github.com/altaris/qrestic
Last synced: 3 months ago
JSON representation
A simple GUI for restic
- Host: GitHub
- URL: https://github.com/altaris/qrestic
- Owner: altaris
- License: mit
- Created: 2022-08-09T13:45:15.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-27T04:31:16.000Z (over 2 years ago)
- Last Synced: 2025-01-07T22:39:05.040Z (4 months ago)
- Language: Python
- Size: 64.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
qrestic
==========
[](https://choosealicense.com/licenses/mit/)
[](https://pypi.org/project/black)
A simple GUI for restic
# Configuration file schema
* `repository`
* `access_key`
* `password`
* `url`: Without the leading `s3:`
* `secret_key`
* `restic`
* `path`
# Contributing
## Dependencies
* `python3.10` or newer;
* `requirements.txt` for runtime dependencies;
* `requirements.dev.txt` for development dependencies.
* `make` (optional);
Simply run
```sh
virtualenv venv -p python3.10
. ./venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt
pip install -r requirements.dev.txt
```
## Documentation
Simply run
```sh
make docs
```
This will generate the HTML doc of the project, and the index file should be at
`docs/index.html`. To have it directly in your browser, run
```sh
make docs-browser
```
## Code quality
Don't forget to run
```sh
make
```
to format the code following [black](https://pypi.org/project/black/),
typecheck it using [mypy](http://mypy-lang.org/), and check it against coding
standards using [pylint](https://pylint.org/).
# Credits
[Feather Icons](https://feathericons.com/)