fime/README.md
2021-11-18 20:11:23 +01:00

37 lines
1.0 KiB
Markdown

# fime
Simple time tracking app written with Python and Qt
Some Jira integration is built in.
## Installation, Qt versions and You
Fime supports using both Qt 5 and Qt 6 via their respective PySide packages.
On Linux I recommend installing the PySide package provided by the distribution.
Install `PySide2` for Qt 5 or `PySide6` for Qt 6.
Run `pip install --user fime` in that case.
On other OSes or if you decide not to follow my recommendation run either
* `pip install --user fime[qt5]` or
* `pip install --user fime[qt6]`
Note that it both versions of PySide are installed Qt 6 will be preferred.
## Config file
The file path is OS dependant. There is an error message on the first start, which will tell you the correct path for
your OS.
Format:
```
jira_url = https://jira.company.com
jira_token = aBc1D34
```
The `jira_token` is a Personal Access Token. See [here](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.htmlh) on how to get one.
## License
Licensed under MIT license. See License.md for more details.