History

jo 32cb67806a chore: add pyupgrade pre-commit hook - add --py3-plus flag to pyupgrade hook - add --py36-plus flag to pyupgrade hook		2022-01-27 10:37:48 +02:00
..
install/systemd	feat(analyzer): load config using shared helpers	2022-01-21 11:54:00 +02:00
libretime_analyzer	chore: add pyupgrade pre-commit hook	2022-01-27 10:37:48 +02:00
tests	feat(analyzer): analyze cuepoint using ffmpeg	2022-01-24 12:54:31 +02:00
tools	Bump php-amqplib/php-amqplib from 2.12.3 to 3.0.0 in /legacy (#1418 )	2021-10-17 21:55:12 +02:00
Makefile	test: allow to set python linters to fail per app	2022-01-26 10:15:35 +02:00
README.md	Move python_apps/airtime_analyzer/ to analyzer/	2021-10-17 08:02:47 +00:00
packages.ini	feat(analyzer): analyze cuepoint using ffmpeg	2022-01-24 12:54:31 +02:00
pyproject.toml	chore: make linters config consistent in pyproject.toml	2022-01-26 10:15:35 +02:00
setup.py	chore: set python build system in pyproject.toml	2022-01-26 10:15:35 +02:00

README.md

libretime-analyzer

libretime-analyzer is a daemon that processes LibreTime file uploads as background jobs.

It performs metadata extraction using Mutagen and moves uploads into LibreTime's music library directory (stor/imported).

libretime-analyzer uses process isolation to make it resilient to crashes and runs in a multi-tenant environment with no modifications.

Installation

python setup.py install

You will need to allow the "airtime" RabbitMQ user to access all exchanges and queues within the /airtime vhost:

rabbitmqctl set_permissions -p /airtime airtime .\* .\* .\*

Usage

This program must run as a user with permissions to write to your Airtime music library directory. For standard Airtime installations, run it as the www-data user:

sudo -u www-data libretime-analyzer --daemon

Or during development, add the --debug flag for more verbose output:

sudo -u www-data libretime-analyzer --debug

To print usage instructions, run:

libretime-analyzer --help

This application can be run as a daemon by running:

libretime-analyzer -d

Developers

For development, you want to install libretime-analyzer system-wide but with everything symlinked back to the source directory for convenience. This is super easy to do, just run:

pip install -r requirements-dev.txt
pip install --editable .

To send an test message to libretime-analyzer, you can use the message_sender.php script in the tools directory. For example, run:

php tools/message_sender.php '{ "tmp_file_path" : "foo.mp3", "final_directory" : ".", "callback_url" : "http://airtime.localhost/rest/media/1", "api_key" : "YOUR_API_KEY" }'

php tools/message_sender.php '{"tmp_file_path":"foo.mp3", "import_directory":"/srv/airtime/stor/imported/1","original_filename":"foo.mp3","callback_url": "http://airtime.localhost/rest/media/1", "api_key":"YOUR_API_KEY"}'

Logging

By default, logs are saved to:

/var/log/airtime/airtime_analyzer.log

This application takes care of rotating logs for you.

Unit Tests

To run the unit tests, execute:

nosetests

If you care about seeing console output (stdout), like when you're debugging or developing a test, run:

nosetests -s

To run the unit tests and generate a code coverage report, run:

nosetests --with-coverage --cover-package=airtime_analyzer