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

Go to file

Peder Bergebakken Sundt b23b02b5e8 grzegorzctl		2024-03-31 04:48:14 +02:00
dist	Switch to use poetry, use a cli interface instead of a config file.	2022-02-20 00:09:25 +01:00
grzegorz_clients	grzegorzctl	2024-03-31 04:48:14 +02:00
.envrc	flake shell	2024-03-31 04:45:22 +02:00
.gitignore	get nixed	2023-08-27 04:33:15 +02:00
LICENSE	Add readme and license	2018-02-26 23:06:09 +01:00
README.md	grzegorzctl	2024-03-31 04:48:14 +02:00
dev.sh	Switch to use poetry, use a cli interface instead of a config file.	2022-02-20 00:09:25 +01:00
flake.lock	get nixed	2023-08-27 04:33:15 +02:00
flake.nix	grzegorzctl	2024-03-31 04:48:14 +02:00
poetry.lock	youtube-dl no more	2023-09-05 00:03:14 +02:00
pyproject.toml	grzegorzctl	2024-03-31 04:48:14 +02: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
CLI client

Planned future clients:

WebExtensions browser extension

How to run this

pip install --user git+https://github.com/Programvareverkstedet/grzegorz_clients.git#master

cli

grzegorzctl

webui

As the user intended to run the server:

pip install --user git+https://github.com/Programvareverkstedet/grzegorz_clients.git#master
grzegorz-webui --host 0.0.0.0 --port 80

It's rather insecure and could use a reverse proxy and some whitelisting. ;)

Making the webui run on boot

Modify and copy the files in dist to $HOME/.config/systemd/user, then run the following commands as the user intended to run the server:

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

Development

Setup virtual environment and running the server:

poetry install
grzegorz-webui --no-volume

If you also run a local instance of the Grzegorz API:

grzegorz-webui --api-base http://localhost:8000/api

If you plan on making changes to the code, preferably install entr and use the supplied script dev.sh. It will restart the server every time you change any of the files tracked by git.

./dev.sh --api-base http://localhost:8000/api

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