Skip to main content

Python library for working with circuit definitions represented using the Bristol Fashion.

Project description

Bristol Fashion Circuit Library (BFCL) for working with circuit definitions represented using the Bristol Fashion.

PyPI version and link. travis coveralls

Purpose

This library includes data structures and associated methods for working with logical circuits typically used in secure multi-party computation (MPC) applications. The data structures follow in their organization the Bristol Fashion format, extrapolating and generalizing where necessary in order to support a wider variety of features and operations.

Package Installation and Usage

The package is available on PyPI:

python -m pip install bfcl

The library can be imported in the usual way:

import bfcl
from bfcl import *

Testing and Conventions

All unit tests are executed and their coverage is measured when using nose (see setup.cfg for configution details):

nosetests

Alternatively, all unit tests are included in the module itself and can be executed using doctest:

python bfcl/bfcl.py -v

Style conventions are enforced using Pylint:

pylint bfcl

Contributions

In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.

Versioning

Beginning with version 0.2.0, the version number format for this library and the changes to the library associated with version number increments conform with Semantic Versioning 2.0.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bfcl-0.3.0.tar.gz (5.1 kB view hashes)

Uploaded Source

Built Distribution

bfcl-0.3.0-py3-none-any.whl (6.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page