Metadata-Version: 2.1
Name: PyCircTools
Version: 1.0.0
Summary: PyCircTools, a python library to build digital circuits.
Home-page: https://github.com/LovetheFrogs/PyCircTools
Author: LovetheFrogs
License: GPL-3.0
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE

[![Known Vulnerabilities](https://snyk.io/test/github/dwyl/hapi-auth-jwt2/badge.svg?targetFile=package.json)](https://snyk.io/test/github/LovetheFrogs/PyCircTools?targetFile=package.json)
[![Code Climate](https://codeclimate.com/github/dwyl/esta/badges/gpa.svg)](https://codeclimate.com/github/LovetheFrogs/PyCircTools)
![PyPI](https://img.shields.io/pypi/v/PyCircTools)
![PyPI - Downloads](https://img.shields.io/pypi/dm/PyCircTools?color=green&label=pip%20downloads)
![PyPI - License](https://img.shields.io/pypi/l/PyCircTools)
![Total lines](https://img.shields.io/tokei/lines/github.com/LovetheFrogs/PyCircTools?color=green&label=total%20lines)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/lovethefrogs?country.x=ES&locale.x=es_ES)
[![hits](https://hits.deltapapa.io/github/LovetheFrogs/PyCircTools.svg)](https://hits.deltapapa.io)

# PyCircTools

PyCircTools is a python package which contains tools to build circuits using python 3. It is a work in progress, and will be updated frequently to add more
modules. 

## Working on...

As of the latest update, I'm working on the next one, which will include adders, shifters and so on. Including a full ALU! To get an insight on current development status, check [#53-create-operation-module](https://github.com/LovetheFrogs/PyCircTools/tree/53-create-operation-modules) branch.

## Table of contents

- [1. Installing PyCircTools and importing it](#installing-CTools)
- [2. Logic Gates Module](#logic-gates)
- [3. Multiplexers Module](#multiplexer)
- [4. Latches Module](#latches)
- [5. Operators](#operators)
- [6. Exceptions](#exceptions) 
- [7. About](#about)

<a name="installing-CTools"></a>
## Installing PyCircTools and importing it.

To install PyCircTools, use pip by calling the following command:

```
pip install PyCircTools
```
Importing it is as easy as it gets, just insert the line 
```
from PyCircTools.*subpackage* import *modules*
``` 
at the start of your code, and substitute subpackage with the package you want, and modules with the modules you want to import to your project.

<a name="logic-gates"></a>
## Logic Gates Module

To read the documentation for this module, [click this link](https://github.com/LovetheFrogs/PyCircTools/tree/main/PyCircTools/LogicGates).

<a name="multiplexers"></a>
## Multiplexers Module

To read the documentation for this module, [click this link](https://github.com/LovetheFrogs/PyCircTools/tree/main/PyCircTools/Multiplexers).

<a name="latches"></a>
## Latches Module

To read the documentation for this module, [click this link](https://github.com/LovetheFrogs/PyCircTools/tree/main/PyCircTools/Latches).

<a name="operators"></a>
## Operators Module

To read the documentation for this module, [click this link](https://github.com/LovetheFrogs/PyCircTools/blob/main/PyCircTools/Operators).

<a name="exceptions"></a>
## Exceptions

To read the documentation for this module, [click this link](https://github.com/LovetheFrogs/PyCircTools/tree/main/PyCircTools/Exceptions).

<a name="about"></a>
## About

PyCircTools is software developed by LovetheFrogs and licensed under GPL-3.0 license. You can support the project and me by donating via PayPal or on [ko-fi.](https://ko-fi.com/E1E4DPZHG)


