cplayer 1.1.2

Song player command line application

CPlayer

Command Line Python player is a minimalist song player written with Python (github), this application offers a wide range of functionality to enhance your music listening, playlist management, filtering and searching songs and more using keyboard shortcuts.

Below, you'll find a comprehensive list of keyboard shortcuts and their corresponding actions within the application, and additional configurations: keyboard shortcuts and customized configurations.

Only tested in Linux.

Table of contents

• Features
• Get started
  • Installation
  • Uninstallation
  • Usage
  • Options
• TODO
• Known issues
• Reports and Debugging
• Developers
  • Set up the Git hooks custom directory
  • Basic configuration
  • Testing
  • Advanced configuration
  • Static code analysis tools
    • Python static checkers
    • Run manually
• License
• Changelog

Features

• GUI customization.
  • If your system does not support the icons used you can set them manually in ~/.config/cplayer/config.yaml.
• Keyboard shortcuts customization.
• Create multiple playlists and manage then.
• Multiple ways to navigate through the playlist including jumping by position, filtering, manual displacements, sorting, etc.
• Download song from a YouTube URL (--url).

Get started

Installation

This application can be simply installed by running:

pip install cplayer

if you want to install from a source distribution:

git clone https://github.com/eccanto/cplayer
cd cplayer/
pip install .

Uninstallation

To uninstall the application you can use pip:

pip uninstall cplayer

Usage

To run the application you must run the command line:

cplayer

By default the application will load the last playlist if it exists, otherwise the application will use the current path to load the .mp3 files from the directory (not recursively).

Options

$ cplayer --help

Usage: cplayer [OPTIONS]

  Command Line Python player CLI.

  This command line tool plays music files from a specified directory or last
  used playlist.

  Examples:

      - Play music from the current directory or the last used playlist if it
      exists:

        $ cplayer

      - Play music from a specific directory:

        $ cplayer --path /path/to/music_directory

      - Download song from YouTube

        $ cplayer --url 'https://www.youtube.com/watch?v=xyz'

  For more information, visit https://github.com/eccanto/cplayer

Options:
  -p, --path PATH  Path to the directory containing your music files.
  -u, --url TEXT   URL of the song to download from YouTube.
  --version        Show the version and exit.
  --help           Show this message and exit.

TODO

• Add favorites feature.
• Add option to restore default configurations.
• Add confirmation dialog to remove/add songs.
• Add "recent" sections: recent folders, recent playlists, recent songs.

Known issues

• tmux subpanels may cause the application dimensions to be incorrect.

Reports and Debugging

The application uses a log file located at ~/.cplayer/logfile.log to report and debug errors. The log file contains detailed information about all errors that occur while the application is running, including the time and date of the error, the error message, and the stack trace.

To view the log file, you can use a text editor or a terminal emulator, e.g.:

tail -f ~/.cplayer/logfile.log

The log file can be used to report and debug errors.

Developers

This project use tox and pytest to run the library tests.

Set up the Git hooks custom directory

After cloning the repository run the following command in the repository root, this ensures that library tests are run before each push into the repository to maintain the quality of the project:

git config core.hooksPath .githooks

Basic configuration

Install development python requirements

pip install -r requirements_dev.txt

Testing

Simply run "tox" to execute all the library tests.

tox

to run the tests for a particular Python version, you can do:

tox -e py38

to clean the test environment:

tox -e clean

to publish the pypi package:

tox -e publish

Advanced configuration

By default tox will look for the python versions available on the system, and will run the compatibility tests on the detected ones, and skip the versions not found. To ensure that compatibility tests are run for all Python versions, the following steps must be followed:

1. Install pyenv

2. Install python versions:

   for python_version in "3.7" "3.8" "3.9" "3.10" "3.11" ; do pyenv install ${python_version}; done
   

3. Enable python versions:

   pyenv local "3.7" "3.8" "3.9" "3.10" "3.11"
   

4. Reinstall virtualenv (if necessary)

   # uninstall virtualenv
   pip uninstall virtualenv
   sudo apt purge python3-virtualenv
   
   # install virtualenv
   pip install virtualenv
   

5. Install development python requirements (if necessary)

   pip install -r requirements_dev.txt
   

Static code analysis tools

These are the static analysis tools that will help us to follow good practices and style guides of our source code. We will be using the following tools, which will be executed when generating a new push in the repository (git hooks).

Python static checkers

Tools used:

• brunette: A best practice Python code formatter.

• isort: Python utility / library to sort imports alphabetically, and automatically separated into sections and by type.

• prospector: Prospector is a tool to analyze Python code and output information about errors, potential problems, convention violations and complexity.

  Tools executed by Prospector:

  • pylint: Pylint is a Python static code analysis tool which looks for programming errors, helps enforcing a coding standard, sniffs for code smells and offers simple refactoring suggestions.
  • bandit: Bandit is a tool designed to find common security issues.
  • dodgy: It is a series of simple regular expressions designed to detect things such as accidental SCM diff checkins, or passwords or secret keys hard coded into files.
  • mccabe: Complexity checker.
  • mypy: Mypy is an optional static type checker for Python.
  • pydocstyle: pydocstyle is a static analysis tool for checking compliance with Python PEP 257.
  • pycodestyle: pycodestyle is a tool to check your Python code against some of the style conventions in PEP 8.
  • pyflakes: Pyflakes analyzes programs and detects various errors.
  • pyroma: Pyroma is a product aimed at giving a rating of how well a Python project complies with the best practices of the Python packaging ecosystem, primarily PyPI, pip, Distribute etc, as well as a list of issues that could be improved.

• twine: The twine check command is used to perform various checks on a Python package distribution before uploading it to the Python Package Index (PyPI) using twine.

Run manually

tox -e check_code

License

MIT

Changelog

• 1.0.0 - Initial version.
• 1.0.1:
  • refactor: Update documentation.
  • fix: Default playlist loading.
  • feat: Add --version command line argument.
• 1.0.2:
  • feat: Download song from a YouTube URL (--url).
• 1.1.0:
  • fix: Update the application when a song is broken.
  • feat: Add log details when downloading a song.
• 1.1.1:
  • fix: Store absolute paths of the songs in the playlist file.
  • refactor: Change keyboard shortcuts (vim style).
• 1.1.2:
  • fix: Handle error when song files are not found.
  • documentation: Add development documentation.
  • refactor: Enable log file.