Metadata-Version: 2.3
Name: beats_swing
Version: 0.1.1
Summary: Determine the tempo of an mp3 song. Tweaked for swing music.
Project-URL: repository, https://github.com/elvijs/beats
Project-URL: homepage, https://github.com/elvijs/beats
Project-URL: issues, https://github.com/elvijs/beats/issues
Author-email: Elvijs Sarkans <elvijs.sarkans@gmail.com>
License-File: LICENSE.txt
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Requires-Dist: librosa<1,>=0.10.2
Description-Content-Type: text/markdown

# beats

![tests](https://github.com/elvijs/beats/workflows/main/badge.svg)
![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)
![Black](https://img.shields.io/badge/code%20style-black-000000.svg)

# What is it?

Determine the tempo of a song from its mp3. Designed for swing music. May work in other cases as well.

This is essentially a thin wrapper on top of the amazing [`librosa`](https://librosa.org/doc/latest/index.html) library.

# Usage

## Non-Python dependencies

```console
$ sudo apt install ffmpeg
```

TODO: describe how to use the CLI

# Development

## Algorithm development

### Scoring new estimators

TODO: document how to score their songs.

### Streamlit apps

TODO

## Package development

### Install in dev mode

```console
$ make install
```

### Common dev tasks

* Auto-format: `make format`
* Run static checkers: `make statec_checks`
* Freeze the local env into `test_requirements` (say, after installing new deps):
  `make freeze_requirements`.

## Issues

Please raise [here](https://github.com/elvijs/beats/issues).

## Credits

This project was generated from [@elvijs](https://github.com/elvijs)'s
[Minimal Python Cookiecutter](https://github.com/elvijs/cookiecutter-minimal-python) template.
