Metadata-Version: 2.1
Name: circuitsascode
Version: 0.0.2
Summary: A collection of SKiDL modules for common electronic circuits.
Home-page: https://github.com/devbisme/circuitsascode
Author: Dave Vandenbout
Author-email: devb@xess.com
License: MIT
Project-URL: Twitter, https://twitter.com/circuitsascode
Project-URL: Tracker, https://github.com/devbisme/circuitsascode/issues
Project-URL: Changelog, https://github.com/devbisme/circuitsascode/latest/CHANGELOG.html
Project-URL: Source, https://github.com/devbisme/circuitsascode
Project-URL: Documentation, https://devbisme.github.io/circuitsascode
Keywords: skidl kicad electronic circuit schematics
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Manufacturing
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Description-Content-Type: text/markdown
License-File: LICENSE.txt
License-File: AUTHORS.md

![Circuits as Code banner](logos/banner.png)

[![](https://img.shields.io/pypi/v/circuitsascode.svg)](https://pypi.python.org/pypi/circuitsascode)

# Circuits as Code

This is a collection of pre-built circuits written as scripts in [SKiDL](http://xesscorp.github.io/skidl).


## Description

[SKiDL](http://xesscorp.github.io/skidl) lets you create electronic circuits by writing Python scripts instead of using a schematic editor.
The `circuitsascode` auxiliary Python package gives you a library of ready-made electronic circuits that serves several purposes:

1. It provides a set of lower-level modules that you can integrate within your own designs.
1. It shows you examples of how to write SKiDL code.

* Free software: MIT license
* Documentation: http://devbisme.github.io/circuitsascode
* User Forum: https://github.com/xesscorp/skidl/discussions

## Installation

You can install this circuit library using `pip`:

```bash
pip install circuitsascode
```

## Usage

Just import the library to use a circuit module:

```py
# Import the function that creates a VGA display interface.
from circuitsascode.displays.vga import vga

# Create color and sync signals to connect to the VGA interface.
red, grn, blu = Bus(5), Bus(4), Bus(3)
hsync, vsync, gnd = Net(), Net(), Net()

# Create a VGA interface circuit customized for the widths
# of the RGB buses.
vga1 = vga(rgb=(len(red), len(grn), len(blu)))

# Connect the signals to the VGA interface circuit.
vga1.red += red
vga1.grn += grn
vga1.blu += blu
vga1.hsync += hsync
vga1.vsync += vsync
vga1.gnd += gnd
```


# Changelog

## Version 0.0.1

- Initial release.


