lib-ringing-python Documentation

Wrapper for the Ringing Class Library.

About

This package contains Python bindings for the Ringing Class Library.

Installation

Wheels are available for Linux systems that bundle the Ringing Class Library and these are the simplest way to install the library.

  1. Install Using pip

    Install directly from PyPI:

    pip install ringing-lib

If a wheel is not available then you’ll need to build from source as follows:

  1. Install the Ringing Class Library.

    You can download the latest source from GitHub. After obtaining appropriate prerequisites you can configure and install. Within the Ringing Class Library source tree:

    make
sudo make install

  2. Install Using pip

    Install directly from PyPI:

    pip install ringing-lib

    Note

    This is a C++ Python extension: you will need a working compiler with access to Python headers in order to build it.

Rather than download from PyPI you may prefer to build from source. Start by installing the Ringing Class Library (as described above) and then clone the repository before building as follows:

  1. Install dependencies and build the Python extension.

    Use uv to install the required dependencies and build the extension:

    make sync

  2. (Optional) Run Tests.

    Run the included tests:

    make check

  3. (Optional) Build package and wheels.

    Build a package for distribution:

    make build-dist
make wheels

Class Documentation

Licence

This software is copyright:

Copyright © 2014-2026 Leigh Simpson <code@simpleigh.com>

This library is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this library. If not, see <http://www.gnu.org/licenses/>.

This documentation is copyright:

Copyright © 2014-2026 Leigh Simpson <code@simpleigh.com>

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.

In addition, large portions of the class documentation are taken directly from the manual for the Ringing Class Library, which is also copyright:

Copyright © 2001-26 Martin Bright, Mark Banner and Richard Smith

Indices and tables