Media player for the Dakara Project
Project description
Dakara player
Interface between the Dakara server and a media player, for the Dakara project.
Installation
To install Dakara completely, you have to get all the parts of the project. Installation guidelines are provided over here:
System requirements
- Python3, for the magic to take place (supported versions: 3.6, 3.7, 3.8 and 3.9).
At least one of there players:
- VLC (supported version: 3.0.0 and higher, note that versions 3.0.13 and 3.0.14 cannot be used);
- mpv (supported version: 0.27 and higher).
For 64 bits operating systems, you must install the equivalent version of the requirements. Linux and Windows are supported.
Virtual environment
It is strongly recommended to use the Dakara player within a virtual environment.
Install
Install the package with:
pip install dakaraplayer
If you have downloaded the repo, you can install the package directly with:
python setup.py install
Usage
The package provides the dakara-play
command which runs the player:
dakara-play
# or
python -m dakara_player
One instance of the Dakara server should be running. For more help:
dakara-play -h
# or
python -m dakara_player -h
Before calling the command, you should create a config file with:
dakara-play create-config
# or
python -m dakara_player create-config
and complete it with your values. The file is stored in your user space: ~/.config/dakara
on Linux or $APPDATA\Dakara
on Windows.
Customization
The different text screens used when the player is idle, or before a song, can be customized, both for the background and the text template.
The program looks for custom files at startup in the user directory: ~/.local/share/dakara/player
on Linux or $APPDATA\Dakara\player
on Windows.
Backgrounds are located in the backgrounds
subfolder, and text templates in the templates
subfolder.
File names can be modified in the config file, see player.templates
and player.backgrounds
.
You can dump the default backgrounds and templates in the user directory as a starter with:
dakara-play create-resources
# or
python -m dakara_player create-resources
Development
Install dependencies
Please ensure you have a recent enough version of setuptools
:
pip install --upgrade "setuptools>=40.0"
Install the dependencies with:
pip install -e ".[tests]"
This installs the normal dependencies of the package plus the dependencies for tests.
Run tests
Run tests simply with:
pytest
# or
python -m pytest
Tests are split between unit tests, which are ligthweight and do not require VLC or mpv to be installed, and integration tests, which are heavier:
pytest tests/unit
pytest tests/integration
# or
python -m pytest tests/unit
python -m pytest tests/integration
To check coverage, use the coverage
command:
coverage run -m pytest
coverage report -m
# or
python -m coverage run -m pytest
python -m coverage report -m
Hooks
Git hooks are included in the hooks
directory.
Use the following command to use this hook folder for the project:
git config core.hooksPath hooks
If you're using git < 2.9 you can make a symlink instead:
ln -s -f ../../hooks/pre-commit .git/hooks/pre-commit
Note that pre-commit hook does not run integration tests.
Code style
The code follows the PEP8 style guide (88 chars per line). Quality of code is checked with Flake8. Style is enforced using Black. You need to call Black before committing changes. You may want to configure your editor to call it automatically. Additionnal checking can be manually performed with Pylint.
The MIT License (MIT)
Copyright (c) 2020 Dakara Project
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dakaraplayer-1.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b2efc66b39119d4939e5557f7122d8be91d092568f878446747dfe7c05df561 |
|
MD5 | 06a22574f0f66615b55899d9fa7079e0 |
|
BLAKE2b-256 | c06f814237c1cb661dd2f60fd52f0d33cd16236cc40b2190269a002f80eacdde |