Congegni
/
sintonia
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
sintonia/api
History
jo b10696265f ci: check and dispatch api schema changes 
- check if api schema is outdated
- do not cancel in progress workflow
  Since this workflow commit to an external repo, it might squash multiple changes into a single commit.
- dispatch each schema update to client repo
- cache pip dependencies
 		2022-06-18 12:13:11 +02:00
..
install/systemd feat: add systemd libretime.target 2022-06-08 23:23:08 +02:00
libretime_api feat: rename default stream mount point to main 2022-06-18 12:08:29 +02:00
Makefile ci: check and dispatch api schema changes 2022-06-18 12:13:11 +02:00
README.md chore: rename vagrant devices (#1716) 2022-03-29 14:25:34 +02:00
packages.ini fix(api): missing build-essential to build psycopg2 2022-06-08 23:23:08 +02:00
pyproject.toml chore(api): add mypy django stubs plugins (#1726) 2022-04-09 12:18:23 +02:00
requirements.txt chore(api): pin django related packages 2022-06-18 11:55:02 +02:00
schema.yml chore(api): add openapi schema 2022-06-18 12:13:11 +02:00
setup.py chore(api): pin django related packages 2022-06-18 11:55:02 +02:00

README.md

LibreTime API

This API provides access to LibreTime's database via a Django application. This API supersedes the PHP API.

Deploying

Deploying in a production environment is done in the install script which installs LibreTime. This is how the API is installed in the Vagrant development images too. This method does not automatically reflect changes to this API. After any changes, the libretime-api systemd service needs restarting:

sudo systemctl restart libretime-api

Connections to the API are proxied through the Apache web server by default. Endpoint exploration and documentation is available from http://example.com/api/v2/schema/swagger-ui/, where example.com is the URL for the LibreTime instance.

Development

For a live reloading version within Vagrant:

vagrant up buster
# Run through the web setup http://localhost:8080
vagrant ssh buster
sudo systemctl stop libretime-api
sudo systemctl restart libretime-analyzer libretime-celery libretime-liquidsoap libretime-playout
cd /vagrant/api
sudo pip3 install -e .
sudo -u www-data LIBRETIME_DEBUG=True libretime-api runserver 0.0.0.0:8081

Unit tests can be run in the vagrant environment using

sudo -u www-data LIBRETIME_DEBUG=True libretime-api test libretime_api

3rd Party Licences

libretime_api/tests/resources/song.mp3: Steps - Tears On The Dancefloor (Album Teaser) by mceyedol. Downloaded from https://soundcloud.com/mceyedol/steps-tears-on-the-dancefloor-album-teaser released under a Creative Commons Licence (cc-by-sa-nc-sa)