Metadata-Version: 2.1
Name: sample-id
Version: 0.1.19
Summary: Acoustic fingerprinting for Sample Identification
Home-page: https://github.com/Curly-Mo/sample-id
License: LGPL-3.0
Author: Colin Fahy
Author-email: colin@cfahy.com
Requires-Python: >=3.7,<3.9
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Provides-Extra: docs
Provides-Extra: mypy
Provides-Extra: vlfeat
Requires-Dist: Cython (>=0.29.22,<0.30.0); extra == "vlfeat"
Requires-Dist: Sphinx (>=3.5.4,<4.0.0); extra == "docs"
Requires-Dist: annoy (>=1.17.0,<2.0.0)
Requires-Dist: click (>=7.1,<8.0)
Requires-Dist: cyvlfeat (>=0.7.0,<0.8.0); extra == "vlfeat"
Requires-Dist: joblib (>=1.0.1,<2.0.0)
Requires-Dist: librosa (>=0.8.0,<0.9.0)
Requires-Dist: matplotlib (>=3.3.4,<4.0.0)
Requires-Dist: mgzip (>=0.2.1,<0.3.0)
Requires-Dist: mutagen (>=1.45.1,<2.0.0)
Requires-Dist: numba (>=0.52.0,<0.53.0)
Requires-Dist: numpy (>=1.16.0,<2.0.0)
Requires-Dist: recommonmark (>=0.7.1,<0.8.0); extra == "docs"
Requires-Dist: seaborn (>=0.11.1,<0.12.0)
Requires-Dist: sklearn (>=0.0,<0.1)
Requires-Dist: sphinx-autobuild (>=2021.3.14,<2022.0.0); extra == "docs"
Requires-Dist: sphinx-autodoc-typehints (>=1.12.0,<2.0.0); extra == "docs"
Requires-Dist: sphinx-click (>=2.7.1,<3.0.0); extra == "docs"
Requires-Dist: sphinx-rtd-theme (>=0.5.2,<0.6.0); extra == "docs"
Requires-Dist: sphinxcontrib-apidoc (>=0.3.0,<0.4.0); extra == "docs"
Requires-Dist: tabulate (>=0.8.9,<0.9.0)
Requires-Dist: toml (>=0.10.2,<0.11.0); extra == "docs"
Requires-Dist: typing (>=3.7,<4.0)
Project-URL: Documentation, https://sample_id.readthedocs.org/en/latest/
Project-URL: Repository, https://github.com/Curly-Mo/sample-id
Description-Content-Type: text/markdown

# Sample ID

[![Build Status](https://app.travis-ci.com/Curly-Mo/sample-id.svg?branch=master)](https://app.travis-ci.com/Curly-Mo/sample-id)
[![Coverage](https://coveralls.io/repos/github/Curly-Mo/sample-id/badge.svg)](https://coveralls.io/github/Curly-Mo/sample-id)
[![Documentation](https://readthedocs.org/projects/sample-id/badge/?version=latest)](https://sample-id.readthedocs.org/en/latest/?badge=latest)
[![PyPI](https://img.shields.io/pypi/v/sample-id.svg)](https://pypi.python.org/pypi/sample-id)
[![PyPI Pythons](https://img.shields.io/pypi/pyversions/sample-id.svg)](https://pypi.python.org/pypi/sample-id)
[![License](https://img.shields.io/pypi/l/sample-id.svg)](https://github.com/Curly-Mo/sample-id/blob/master/LICENSE)

Acoustic fingerprinting for Sample Identification

## Features

* What it do?

## Usage

* TODO

## Install

```console
pip install sample-id
```

## Documentation
See https://sample-id.readthedocs.org/en/latest/

## Development
```console
pip install poetry
cd sample-id
poetry install
```
### Run
To run cli entrypoint:
```console
poetry run sample_id --help
```

### Tests
```console
poetry run tox
```

### Docker
To run with docker
```console
docker build -t sample_id .
docker run sample_id:latest sample_id --help
```

