Metadata-Version: 2.1
Name: circuitsascode
Version: 0.0.1
Summary: A collection of SKiDL modules for common electronic circuits.
Home-page: https://devbisme.github.io/circuitsascode
Author: Dave Vandenbout
Author-email: devb@xess.com
License: MIT
Project-URL: Documentation, https://devbisme.github.io/circuitsascode/api/html/index.html
Project-URL: Source, https://github.com/devbisme/circuitsascode
Project-URL: Changelog, https://github.com/devbisme/circuitsascode/blob/master/CHANGELOG.md
Project-URL: Tracker, https://github.com/devbisme/circuitsascode/issues
Project-URL: Twitter, https://twitter.com/circuitsascode
Description: ![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
        ```
        
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Requires-Python: >=2.7
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Provides-Extra: testing
