Metadata-Version: 2.1
Name: fake-rpigpio
Version: 0.1.0
Summary: Fake Raspberry PI GPIO drop-in replacement for RPi.GPIO
Home-page: https://github.com/vapor-ware/fake-rpigpio
Author: Erick Daniszewski
Author-email: erick@vapor.io
License: GNU General Public License v3.0
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/markdown

# fake-rpigpio

`fake-rpigpio` is a package intended to provide a lightweight (dependency-free) fake
interface for Raspberry Pi GPIO. The GPIO functions match those in the [`RPi.GPIO`](https://pypi.org/project/RPi.GPIO/)
library, however the functions do nothing. This makes it easier to test GPIO-related code
and to get the code to run on non-pi machines.

## Installation

This package can be installed via pip:

```
pip install fake-rpigpio
``` 

## Usage

A basic example of using this package to run with `RPi.GPIO` on a Pi and `fake-rpigpio` on
a non-Pi:

```python
try:
    import RPi.GPIO
except (RuntimeError, ModuleNotFoundError):
    import fake_rpigpio.utils
    fake_rpigpio.utils.install()
```

This will install `fake-rpigpio.RPi` as `RPi` and `fake-rpigpio.RPi.GPIO` as `RPi.GPIO`,
so you should not need to change imports for the `RPi.GPIO` library.

## Acknowledgements

The following projects inspired this one. While all are similar, the usage and dependency
weight varies between projects.

* [`fake_rpi`](https://github.com/MomsFriendlyRobotCompany/fake_rpi)
* [`fakeRPiGPIO`](https://github.com/luxedo/fakeRPiGPIO)


