/qrestic

A simple GUI for restic

Primary LanguagePythonMIT LicenseMIT

qrestic

Python 3 License Code style

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

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

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

make docs-browser

Code quality

Don't forget to run

make

to format the code following black, typecheck it using mypy, and check it against coding standards using pylint.

Credits

Feather Icons