sintonia/analyzer
Jonas L 1147853c63
feat(shared): pass config data via init (#2042)
2022-08-12 15:12:39 +02:00
..
install/systemd feat: use dedicated 'libretime' user 2022-07-07 10:51:07 +02:00
libretime_analyzer feat(shared): pass config data via init (#2042) 2022-08-12 15:12:39 +02:00
tests feat(analyzer): override paths using env variables 2022-08-09 21:07:07 +02:00
tools feat: change config dir path to /etc/libretime 2022-06-08 23:23:08 +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 chore(analyzer): move python3-pika in the python section (#1746) 2022-04-09 14:35:28 +00:00
pyproject.toml chore: pin setuptools to <64.0.0 for build backend 2022-08-11 22:16:00 +02:00
requirements.txt chore(analyzer): update pika version range 2022-07-17 21:25:37 +02:00
setup.py chore: remove chdir in setup.py files 2022-07-27 15:35:57 +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 libretime user:

sudo -u libretime libretime-analyzer --daemon

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

sudo -u libretime 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://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://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

Running in a Multi-Tenant Environment

History and Design Motivation