History

jo 5bf62dd9cb feat(legacy): read stream config from file - We don't delete the stream preferences from the database to prevent data loss. This will be handled in a future release.		2022-09-06 13:21:54 +02:00
..
install/systemd	feat(api): use uvicorn as asgi server with gunicorn	2022-07-07 10:51:07 +02:00
libretime_api	feat(legacy): read stream config from file	2022-09-06 13:21:54 +02:00
Makefile	chore: install local python deps in editable mode	2022-07-27 15:35:57 +02:00
README.md	feat: use dedicated 'libretime' user	2022-07-07 10:51:07 +02:00
packages.ini	fix(api): install gunicorn from pip for bionic	2022-09-01 19:17:33 +02:00
pyproject.toml	chore: revert pin setuptools to <64.0.0 for build backend	2022-08-25 09:51:36 +02:00
requirements.txt	chore: rewrite extract-requirements to python	2022-07-17 21:25:37 +02:00
schema.yml	feat(api): don't use hyperlinked serializers (#1984 )	2022-07-27 09:54:57 +02:00
setup.py	chore: remove chdir in setup.py files	2022-07-27 15:35:57 +02:00

README.md

LibreTime API

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

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 development, you can install all required dependencies and loading the environment using the following command:

make install
source .venv/bin/activate

You should be able to lint or format the code or run api commands:

make format
make lint

libretime-api help

In order to work with the database and message queue, you need to start the docker based development stack present at the project root:

pushd ..
docker-compose up -d
popd

You can now run the api tests:

make test

Inside Vagrant

You can develop the api using a live reloading version within Vagrant:

vagrant up bullseye
vagrant ssh bullseye

cd /vagrant/api
sudo pip3 install -e .

sudo systemctl stop libretime-api
sudo -u libretime LIBRETIME_DEBUG=True libretime-api runserver 0.0.0.0:8081

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)