Metadata-Version: 2.1
Name: pypitch
Version: 2.0
Summary: PyPitch analyses audio streams for pitch
Home-page: https://fofix.org
Author: FoFiX team
Author-email: contact@fofix.org
License: GPLv2+
Project-URL: Documentation, https://pypitch.readthedocs.io
Project-URL: Source Code, https://github.com/fofix/python-pypitch
Project-URL: Bug Tracker, https://github.com/fofix/python-pypitch/issues
Keywords: pitch audio
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Programming Language :: C++
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Multimedia
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/markdown
Provides-Extra: tests
Provides-Extra: docs
License-File: LICENSE

# PyPitch

[![Tests](https://github.com/fofix/python-pypitch/workflows/Tests/badge.svg?branch=master)](https://github.com/fofix/python-pypitch/actions?query=workflow:Tests)
[![Build status](https://ci.appveyor.com/api/projects/status/0f6yb99cd37v6li6?svg=true)](https://ci.appveyor.com/project/Linkid/python-pypitch)
[![Documentation Status](https://readthedocs.org/projects/pypitch/badge/?version=latest)](http://pypitch.readthedocs.io/en/latest/?badge=latest)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/pypitch.svg)](https://pypi.python.org/pypi/pypitch)


PyPitch is a C++-extension in Python to analyse audio streams for pitch.


## Setup

Build the extension:

    $ python setup.py build_ext --inplace --force

Install it:

    $ python -m pip install .


## Usage

Import it:

    from pypitch import pypitch


## Doc

To build the html doc from source::

    $ python -m pip install -e .[docs]
    $ cd doc
    $ make html

or::

    $ python -m pip install -e .[docs]
    $ python setup.py build_sphinx
