mirror of https://github.com/borgbase/vorta synced 2024-12-23 16:26:55 +00:00

* Dont open main window on startup unless --foreground is given. Fixes #91
* Clean up README. #93
* Make sentry reporting a setting.

2018-12-18 19:23:34 +08:00

1.7 KiB

Raw Blame History

Contributing

First off, thanks for taking the time to contribute!

All contributions that improve Vorta for everyone are welcome. Before coding a new feature it's usually best to discuss it with other users under Issues. Once everything is clear, follow the instructions below to

Local Development Setup

Clone the latest version of this repo

$ git clone https://github.com/borgbase/vorta/

Install in development/editable mode while in the repo root:

$ pip install -e .

Install additional developer packages (pytest, tox, pyinstaller):

pip install -r requirements.d/dev.txt

Then run as Python script. Any changes from your source folder should be reflected.

$ vorta

Working on the GUI

Qt Creator is used to edit views. Install from their site or using Homebrew and then open the .ui files in vorta/UI with Qt Creator:

$ brew cask install qt-creator
$ brew install qt

Building Binaries

To build a macOS app package:

add Sparkle.framework from here and borg from here in bin/macosx64
then uncomment or change the Apple signing profile to be used in Makefile
finally run to $ make Vorta.app to build the app into the dist folder.

Testing

Tests are in the folder /tests. Testing happens at the level of UI components. Calls to borg are mocked and can be replaced with some example json-output. To run tests:

$ pytest

To test for style errors:

$ flake8