Embedded domain-specific combinator library for assembling abstract definitions of logic circuits.
Project description
Embedded domain-specific combinator library for assembling abstract definitions of logic circuits.
Purpose
This embedded domain-specific language (DSL) makes it possible to write an algorithm in Python that operates over bit vectors, and then to interpret that algorithm implementation as a circuit definition in order to synthesize a logic circuit represented using the circuit library. Additional background information and examples can be found in a relevant report.
Package Installation and Usage
The package is available on PyPI:
python -m pip install circuitry
The library can be imported in the usual ways:
import circuitry from circuitry import *
Documentation
The documentation can be generated automatically from the source files using Sphinx:
cd docs python -m pip install -r requirements.txt sphinx-apidoc -f -E --templatedir=_templates -o _source .. ../setup.py && make html
Testing and Conventions
All unit tests are executed and their coverage is measured when using pytest (see setup.cfg for configuration details):
python -m pip install pytest pytest-cov python -m pytest
Alternatively, all unit tests are included in the module itself and can be executed using doctest:
python circuitry/circuitry.py -v
Style conventions are enforced using Pylint:
python -m pip install pylint python -m pylint circuitry
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.1.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.
Publishing
This library can be published as a package on PyPI by a package maintainer. Install the wheel package, remove any old build/distribution files, and package the source into a distribution archive:
python -m pip install wheel rm -rf dist *.egg-info python setup.py sdist bdist_wheel
Next, install the twine package and upload the package distribution archive to PyPI:
python -m pip install twine python -m twine upload dist/*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for circuitry-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bcb42450d8acd4dcb5f26ad25aea0e05e85a33491e91e66469254749f28e4a85 |
|
MD5 | 6ea5c46c050ca5b774d9e5801b82fab7 |
|
BLAKE2b-256 | b0a2d671f96e0cbe1cdd1b68c8a3491bcfff14eb3e4855f6214e94996c9aede4 |