Projects/grzegorz-clients
Projects
/
grzegorz-clients
7
1
Fork 0
Code Issues 1 Pull Requests 1 Wiki Activity
A set of simple API endpoints and ready-to-go clients to interface with the Grzegorz API
78 Commits 4 Branches 0 Tags 1.8 MiB
Python 57%
CSS 32.3%
Nix 10.4%
Shell 0.3%
Go to file
Peder Bergebakken Sundt 546d921ec4 flake.lock: Update 
Flake lock file updates:

• Updated input 'nixpkgs':
    'github:NixOS/nixpkgs/d8fe5e6c92d0d190646fb9f1056741a229980089' (2024-03-29)
  → 'github:NixOS/nixpkgs/c04d5652cfa9742b1d519688f65d1bbccea9eb7e' (2024-09-19)
 		2024-09-20 21:52: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 Merge pull request 'webui: handle playback_pos response with empty contents' (#13) from handle-empty-playback-pos-response into master 2024-08-05 21:16:57 +02:00
.envrc flake shell 2024-03-31 04:45:22 +02:00
.gitignore lock 2024-03-31 04:48:21 +02:00
LICENSE Add readme and license 2018-02-26 23:06:09 +01:00
README.md lkjlkjdsalkj 2024-05-10 20:04:30 +02:00
dev.sh webui: view slice if len(playlist) > 100 2024-05-11 01:44:11 +02:00
flake.lock flake.lock: Update 2024-09-20 21:52:14 +02:00
flake.nix flake: add grzegorzctl-only package which installs shell-completions 2024-05-19 06:39:23 +02:00
poetry.lock poetry lock 2024-05-10 18:52:27 +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-name 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