refactor(airtime_analyzer): rename to libretime-analyzer and make entrypoint pythonic
This commit is contained in:
Lucas Bickel
GitHub
parent
b6d22c94a1
commit
e21abf1bf1
15 changed files with 155 additions and 170 deletions
102
python_apps/airtime_analyzer/README.md
Normal file
102
python_apps/airtime_analyzer/README.md
Normal file
|
|
@ -0,0 +1,102 @@
|
|||
# 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
|
||||
|
||||
```bash
|
||||
python setup.py install
|
||||
```
|
||||
|
||||
You will need to allow the "airtime" RabbitMQ user to access all exchanges and queues within the /airtime vhost:
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```bash
|
||||
sudo -u www-data libretime-analyzer --daemon
|
||||
```
|
||||
|
||||
Or during development, add the --debug flag for more verbose output:
|
||||
|
||||
```bash
|
||||
sudo -u www-data libretime-analyzer --debug
|
||||
```
|
||||
|
||||
To print usage instructions, run:
|
||||
|
||||
```bash
|
||||
libretime-analyzer --help
|
||||
```
|
||||
|
||||
This application can be run as a daemon by running:
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```bash
|
||||
nosetests
|
||||
```
|
||||
|
||||
If you care about seeing console output (stdout), like when you're debugging or developing
|
||||
a test, run:
|
||||
|
||||
```bash
|
||||
nosetests -s
|
||||
```
|
||||
|
||||
To run the unit tests and generate a code coverage report, run:
|
||||
|
||||
```bash
|
||||
nosetests --with-coverage --cover-package=airtime_analyzer
|
||||
```
|
||||
|
||||
## Running in a Multi-Tenant Environment
|
||||
|
||||
## History and Design Motivation
|
||||
|
|
@ -1,95 +0,0 @@
|
|||
airtime_analyzer
|
||||
==========
|
||||
|
||||
airtime_analyzer is a daemon that processes Airtime file uploads as background jobs.
|
||||
It performs metadata extraction using Mutagen and moves uploads into Airtime's
|
||||
music library directory (stor/imported).
|
||||
|
||||
airtime_analyzer uses process isolation to make it resilient to crashes and runs in
|
||||
a multi-tenant environment with no modifications.
|
||||
|
||||
Installation
|
||||
==========
|
||||
|
||||
$ sudo python setup.py install
|
||||
|
||||
You will need to allow the "airtime" RabbitMQ user to access all exchanges and queues within the /airtime vhost:
|
||||
|
||||
sudo 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 airtime_analyzer --daemon
|
||||
|
||||
Or during development, add the --debug flag for more verbose output:
|
||||
|
||||
$ sudo -u www-data airtime_analyzer --debug
|
||||
|
||||
To print usage instructions, run:
|
||||
|
||||
$ airtime_analyzer --help
|
||||
|
||||
This application can be run as a daemon by running:
|
||||
|
||||
$ airtime_analyzer -d
|
||||
|
||||
Other runtime flags can be listed by running:
|
||||
|
||||
$ airtime_analyzer --help
|
||||
|
||||
|
||||
Developers
|
||||
==========
|
||||
|
||||
For development, you want to install airtime_analyzer system-wide but with everything symlinked back to the source
|
||||
directory for convenience. This is super easy to do, just run:
|
||||
|
||||
$ sudo python setup.py develop
|
||||
|
||||
To send an test message to airtime_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
|
||||
|
||||
|
||||
Running in a Multi-Tenant Environment
|
||||
===========
|
||||
|
||||
|
||||
History and Design Motivation
|
||||
===========
|
||||
|
||||
|
||||
|
|
@ -1,7 +1,6 @@
|
|||
#!/usr/bin/env python
|
||||
"""Runs the airtime_analyzer application.
|
||||
"""
|
||||
|
||||
Main CLI entrypoint for the libretime-analyzer app.
|
||||
"""
|
||||
|
||||
import daemon
|
||||
import argparse
|
||||
|
|
@ -13,9 +12,9 @@ LIBRETIME_CONF_DIR = os.getenv('LIBRETIME_CONF_DIR', '/etc/airtime')
|
|||
DEFAULT_RMQ_CONFIG_PATH = os.path.join(LIBRETIME_CONF_DIR, 'airtime.conf')
|
||||
DEFAULT_HTTP_RETRY_PATH = '/tmp/airtime_analyzer_http_retries'
|
||||
|
||||
def run():
|
||||
def main():
|
||||
'''Entry-point for this application'''
|
||||
print("Airtime Analyzer {}".format(VERSION))
|
||||
print("LibreTime Analyzer {}".format(VERSION))
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("-d", "--daemon", help="run as a daemon", action="store_true")
|
||||
parser.add_argument("--debug", help="log full debugging output", action="store_true")
|
||||
|
|
@ -42,4 +41,5 @@ def run():
|
|||
http_retry_queue_path=http_retry_queue_path,
|
||||
debug=args.debug)
|
||||
|
||||
run()
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
Description=LibreTime Media Analyzer Service
|
||||
|
||||
[Service]
|
||||
ExecStart=/usr/bin/airtime_analyzer
|
||||
ExecStart=/usr/bin/libretime-analyzer
|
||||
User=libretime-analyzer
|
||||
Group=libretime-analyzer
|
||||
Restart=always
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
#!/bin/bash
|
||||
|
||||
### BEGIN INIT INFO
|
||||
# Provides: airtime_analyzer
|
||||
# Provides: libretime-analyzer
|
||||
# Required-Start: $local_fs $remote_fs $network $syslog $all
|
||||
# Required-Stop: $local_fs $remote_fs $network $syslog
|
||||
# Default-Start: 2 3 4 5
|
||||
# Default-Stop: 0 1 6
|
||||
# Short-Description: Manage airtime_analyzer daemon
|
||||
# Short-Description: Manage libretime-analyzer daemon
|
||||
### END INIT INFO
|
||||
|
||||
USERID=www-data
|
||||
GROUPID=www-data
|
||||
NAME=airtime_analyzer
|
||||
NAME=libretime-analyzer
|
||||
|
||||
DAEMON=/usr/bin/$NAME
|
||||
PIDFILE=/var/run/$NAME.pid
|
||||
|
|
|
|||
|
|
@ -15,10 +15,10 @@ env LANG='en_US.UTF-8'
|
|||
env LC_ALL='en_US.UTF-8'
|
||||
|
||||
#script
|
||||
# airtime_analyzer
|
||||
# libretime-analyzer
|
||||
#end script
|
||||
|
||||
exec airtime_analyzer
|
||||
exec libretime-analyzer
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
3
python_apps/airtime_analyzer/requirements-dev.txt
Normal file
3
python_apps/airtime_analyzer/requirements-dev.txt
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
coverage
|
||||
mock
|
||||
nose
|
||||
|
|
@ -1,58 +1,31 @@
|
|||
from __future__ import print_function
|
||||
from setuptools import setup
|
||||
from subprocess import call
|
||||
import sys
|
||||
import os
|
||||
|
||||
# Change directory since setuptools uses relative paths
|
||||
script_path = os.path.dirname(os.path.realpath(__file__))
|
||||
print(script_path)
|
||||
os.chdir(script_path)
|
||||
os.chdir(os.path.dirname(os.path.realpath(__file__)))
|
||||
|
||||
# Allows us to avoid installing the upstart init script when deploying airtime_analyzer
|
||||
# on Airtime Pro:
|
||||
if '--no-init-script' in sys.argv:
|
||||
data_files = []
|
||||
sys.argv.remove('--no-init-script') # super hax
|
||||
else:
|
||||
data_files = [('/etc/init', ['install/upstart/airtime_analyzer.conf']),
|
||||
('/etc/init.d', ['install/sysvinit/airtime_analyzer'])]
|
||||
print(data_files)
|
||||
|
||||
setup(name='airtime_analyzer',
|
||||
version='0.1',
|
||||
description='Airtime Analyzer Worker and File Importer',
|
||||
url='http://github.com/sourcefabric/Airtime',
|
||||
author='Albert Santoni',
|
||||
author_email='albert.santoni@sourcefabric.org',
|
||||
license='MIT',
|
||||
packages=['airtime_analyzer'],
|
||||
scripts=['bin/airtime_analyzer'],
|
||||
install_requires=[
|
||||
'mutagen==1.42.0',
|
||||
'pika~=1.1.0',
|
||||
'file-magic',
|
||||
'nose',
|
||||
'coverage',
|
||||
'mock',
|
||||
'python-daemon',
|
||||
'requests>=2.7.0',
|
||||
'rgain3==1.0.0',
|
||||
'pycairo==1.19.1',
|
||||
'PyGObject<=3.36.1',
|
||||
# These next 3 are required for requests to support SSL with SNI. Learned this the hard way...
|
||||
# What sucks is that GCC is required to pip install these.
|
||||
#'ndg-httpsclient',
|
||||
#'pyasn1',
|
||||
#'pyopenssl'
|
||||
],
|
||||
zip_safe=False,
|
||||
data_files=data_files)
|
||||
|
||||
# Remind users to reload the initctl config so that "service start airtime_analyzer" works
|
||||
if data_files:
|
||||
print("Remember to reload the initctl configuration")
|
||||
print("Run \"sudo initctl reload-configuration; sudo service airtime_analyzer restart\" now.")
|
||||
print("Or on Ubuntu Xenial (16.04)")
|
||||
print("Remember to reload the systemd configuration")
|
||||
print("Run \"sudo systemctl daemon-reload; sudo service airtime_analyzer restart\" now.")
|
||||
setup(
|
||||
name="libretime-analyzer",
|
||||
version="0.1",
|
||||
description="Libretime Analyzer Worker and File Importer",
|
||||
url="https://libretime.org",
|
||||
author="LibreTime Contributors",
|
||||
license="AGPLv3",
|
||||
packages=["airtime_analyzer"],
|
||||
entry_points={
|
||||
"console_scripts": [
|
||||
"libretime-analyzer=airtime_analyzer.cli:main",
|
||||
]
|
||||
},
|
||||
install_requires=[
|
||||
"mutagen==1.42.0",
|
||||
"pika~=1.1.0",
|
||||
"file-magic",
|
||||
"python-daemon",
|
||||
"requests>=2.7.0",
|
||||
"rgain3==1.0.0",
|
||||
"pycairo==1.19.1",
|
||||
"PyGObject<=3.36.1",
|
||||
],
|
||||
zip_safe=False,
|
||||
)
|
||||
|
|
|
|||
|
|
@ -162,4 +162,4 @@ def test_mp3_bad_channels():
|
|||
#Mutagen doesn't extract comments from mp3s it seems
|
||||
|
||||
def test_unparsable_file():
|
||||
MetadataAnalyzer.analyze('README.rst', dict())
|
||||
MetadataAnalyzer.analyze('tests/test_data/unparsable.txt', dict())
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
test-file
|
||||
Loading…
Add table
Add a link
Reference in a new issue