Overview

Self-hosted open source multimedia scrobbler

Installing¶

pip install pyscrobbler

A Simple Example¶

import pyscrobbler  # noqa # noqa

References¶

As most open sourced programs, pyscrobbler is standing on the shoulders of giants, namely:

Pytest

Testing framework, enhanced by the awesome pytest-cases library that made the parametrization of the tests a lovely experience.

Mypy

Python static type checker.

Flakehell

Python linter with lots of checks.

Black

Python formatter to keep a nice style without effort.

Autoimport

Python formatter to automatically fix wrong import statements.

isort

Python formatter to order the import statements.

Pip-tools

Command line tool to manage the dependencies.

Mkdocs

To build this documentation site, with the Material theme.

Safety

To check the installed dependencies for known security vulnerabilities.

Bandit

To finds common security issues in Python code.

Yamlfix

YAML fixer.

Contributing¶

For guidance on setting up a development environment, and how to make a contribution to pyscrobbler, see Contributing to pyscrobbler.