Welcome to pypitch’s documentation!¶

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

Installation¶

Install package with pip¶

To install with pip:

$ pip install pypitch

Install from source¶

To install pypitch from the latest source, first obtain the source code:

$ git clone https://github.com/fofix/python-pypitch
$ cd python-pypitch

then build the extension:

$ python setup.py build_ext --inplace

then install with:

$ pip install .

or:

$ pip install -e .

for development.

Dependencies¶

Python Packages¶

To use this package, you will need Cython.

Compiler Toolchain¶

The same compiler toolchain used to build the CPython interpreter should also be available. Refer to the CPython Developer’s Guide for details about the compiler toolchain for your operating system.

Usage¶

Import¶

To use PyPitch in your project:

from pypitch import pypitch

Modules¶

There a two modules available:

Analyzer: to analyze input audio and transform it into usable data
Tone: to represent tones.

History¶

This module was extracted from FoFiX, and was inspired from Performous.

First, it was a pure-Python script named PitchAnalyzer. This script is available in the version 3 of FoFiX.

To speed up this FoFiX, this script were adapted in C++ in the version 4.

Release notes¶

2.0 (2023-07-20)¶

build: drop python 3.6 support
build: add python 3.10 support
build: add python 3.11 support
build: remove pytest-runner from setup requirements

1.3 (2020-12-17)¶

Python 3.9 compatibility
Setup: update contact information
CI: replace Travis with Github Actions
Code: remove the sqrLT function

1.2 (2020-04-12)¶

Python 3 compatible (CI, code, tests)
Code: use std::fmod instead of std::remainder only for Visual C++ 9.0 (Windows & python 2.7)
Doc: add a release section
Setup: use bumpversion to bump the version easily

1.1 (2020-04-10)¶

Doc: initialise some basics
Setup: correctly use the relative path of the README file
Setup: declare ‘docs’ extra for the documentation
Setup: declare ‘tests’ extra for tests
Setup / osx: use libc++ to compile the extension (xcode >= 10)
Tests: restrict the pytest version (< 5)

1.0 (2020-03-15)¶

Initial release. Extracted from FoFiX.

How to release¶

Create a release¶

Here is the release process for PyPitch:

bump the version (will commit):

python -m pip install bumpversion
bumpversion release

update the changelog date (in the same commit):

vim CHANGELOG.md
git add CHANGELOG.md
git commit --amend

make a PR
if tests pass on Travis, merge the PR
make a tag:
```
git tag VERSION
```

make the source distribution:

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

make wheels with AppVeyor
upload sources and wheels on GitHub in a new release.

Upload to PyPI¶

You need to upload sources and wheels to PyPI:

python -m pip install twine
twine upload -r pypi dist/*

Note

First, upload on TestPyPI:

$ twine upload -r pypitest dist/*

Then, you need to test the installation:

pushd $(mktemp -d)
mktmpenv
pip install -i https://test.pypi.org/simple pypitch
python -c "from pypitch import pypitch; print(pypitch.__version__)"
deactivate
popd

Prepare the next release¶

To prepare the next release:

bump the version (with PART in [major, minor, patch], will commit):
```
bumpversion PART
```
update the changelog to add the unreleased subsection (in the same commit):
```
vim CHANGELOG.md
git add CHANGELOG.md
git commit --amend
```
make a PR.