sintonia/api
Jonas L 703a8e5856
chore: remove cloud storage remainings (#1934)
2022-07-04 22:09:14 +02:00
..
install/systemd feat: add systemd libretime.target 2022-06-08 23:23:08 +02:00
libretime_api chore: remove cloud storage remainings (#1934) 2022-07-04 22:09:14 +02:00
Makefile chore: update python tests target 2022-06-30 13:24:05 +02:00
README.md chore(api): update README 2022-06-29 06:04:31 +02:00
packages.ini fix(api): missing build-essential to build psycopg2 2022-06-08 23:23:08 +02:00
pyproject.toml test(api): ignore tests file coverage 2022-06-30 13:24:05 +02:00
requirements.txt feat(api): create bulk_import command 2022-06-28 19:05:14 +02:00
schema.yml chore: remove cloud storage remainings (#1934) 2022-07-04 22:09:14 +02:00
setup.py feat(api): create bulk_import command 2022-06-28 19:05:14 +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 www-data 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)