Package: dakaraplayervlc
Dakara VLC playerInterface between the Dakara server and VLC, for the Dakara project.InstallationTo install Dakara completely, you have to get all the parts of the project.
Installation guidelines are provided over here:Dakara server;Dakara feeder.System requirementsPython3, for the magic to take place (supported versions: 3.5, 3.6);VLC, duh.For 64 bits operating systems, you must install the equivalent version of the requirements.
Linux and Windows are supported.Virtual environmentIt is strongly recommended to use the Dakara VLC player within a virtual environment.InstallInstall the package with:pipinstalldakaraplayervlcIf you have downloaded the repo, you can install the package directly with:pythonsetup.pyinstallUsageThe package provides thedakara-play-vlccommand which runs the player:dakara-play-vlc# orpython-mdakara_player_vlcOne instance of the Dakara server should be running. For more help:dakara-play-vlc-h# orpython-mdakara_player_vlc-hBefore calling the command, you should create a config file with:dakara-play-vlccreate-config# orpython-mdakara_player_vlccreate-configand complete it with your values. The file is stored in your user space:~/.config/dakaraon Linux or$APPDATA\Dakaraon Windows.DevelopmentInstall dependenciesPlease ensure you have a recent enough version ofsetuptools:pipinstall--upgrade"setuptools>=40.0"Install the dependencies with:pipinstall-e".[tests]"This installs the normal dependencies of the package plus the dependencies for tests.Run testsRun tests simply with:pythonsetup.pytestTo check coverage, use thecoveragecommand:coveragerunsetup.pytestcoveragereport-mHooksGit hooks are included in thehooksdirectory.Use the following command to use this hook folder for the project:git config core.hooksPath hooksIf you're using git < 2.9 you can make a symlink instead:ln -s -f ../../hooks/pre-commit .git/hooks/pre-commitNote that pre-commit hook does not run integration tests.Code styleThe code follows thePEP8style guide (88 chars per line).
Quality of code is checked withFlake8.
Style is enforced usingBlack.
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 withPylint.The MIT License (MIT)Copyright (c) 2020 Dakara ProjectPermission 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.