A set of simple API endpoints and ready-to-go clients to interface with the Grzegorz API

Go to file

Peder Bergebakken Sundt 0c24327429 Add a neat little easter-egg		2019-03-13 12:19:30 +01:00
dist	Add systemd config	2019-03-09 20:53:57 +01:00
grzegorz_clients	Add a neat little easter-egg	2019-03-13 12:19:30 +01:00
.gitignore	Add missing type annotations to api methods	2018-03-04 18:33:26 +01:00
LICENSE	Add readme and license	2018-02-26 23:06:09 +01:00
README.md	Add systemd config	2019-03-09 20:53:57 +01:00
default_config.py	Add dev.sh	2018-03-05 21:43:58 +01:00
dev.sh	Add optional --no-volume program argument	2018-03-06 14:29:13 +01:00
main.py	Fix missing import used on first-time setup	2019-03-13 11:21:07 +01:00
requirements.txt	Add requests to requirements.txt	2018-03-12 15:32:22 +01:00

README.md

Gregorz Clients

A set of simple API endpoints and ready-to-go clients to interface with the Grzegorz API

Working clients:

A webUI client made with REMI

Planned future clients:

CLI client
WebExtensions browser extension

How to run this

First of we need to install any needed dependencies. If you want to, you may do so in a virtual environment.

To install the needed dependencies, run this with sufficient rights (as root?):

pip install -r requirements.txt

Now, make a copy of default_config.py named config.py, and make any changes you see fit. Each field should be described in the file.

When finished, run the server with:

python3 main.py

Making the webui run on boot

Copy the files in the folder dist into $HOME/.config/systemd/user and run the following commands as the user intended to run the server:

$ systemd --user enable grzegorz_webui.service
$ systemd --user start grzegorz_webui.service

Developing on this

If you plan on making changes to the code, i advice you to install entr and use the supplied script dev.sh. It will restart the server everytime you write a change to any of the .py files in the project.

License

Licensed under BSD 3 clause, see the file LICENSE for more details

This uses the library REMI by dddomodossola, which is licensed under apache2. This license may be read over here