Metadata-Version: 2.1
Name: homehubRPi
Version: 1.0.0
Summary: A small home hub example package
Home-page: https://github.com/ngonimombeshora/homehubRPi
Author: Ngoni Mombeshora
Author-email: nmombeshora3@gmail.com
License: UNKNOWN
Download-URL: https://github.com/ngonimombeshora/homehubRPi/tree/main/dist/homehubRPi-1.0.0.tar.gz
Keywords: Smart home,IOT,Raspberry Pi,pip3,python,MQTT,HTTP/s,RESTful
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Operating System Kernels :: Linux
Requires-Python: >=3.6
Description-Content-Type: text/markdown

<h1 align="center">
homehubRPi PyPI module
</h1>

https://github.com/ngonimombeshora/homehubRPi

#### Current package in testing available at PyPI

[homehubRPi](https://test.pypi.org/project/homehubRPi/)

###### Project Desription

HomehubRPI package was specifically made for those wanting to implement bespoke Smart Home ecosystems. Currently runs on all Raspberry Pi's and can be extended to any other boards e.g Arduino, ESP8632, PocketBeagle etc. Only a few twitches would need to be done to suit the specific board type and I/O pin configurations. Some modules work without needing any tweaking. For example HTTPCommunications module.
Provides mqtt, http and hardware adbstraction.

This package works in tandem with [hubAPI](https://github.com/ngonimombeshora?tab=repositories) which hosts the database and front-end API for developers. This API can be hosted online or on a local server. Otherwise if one wishes they can use the one hosted on the public domain on netlify at [Insert netlify url](https://guides.github.com/features/mastering-markdown/), which still offers the same amount of security and privacy to ones own smart home ecosystem.

## 🚀 Getting Started

```sh
pip3 install homehubRPI
```

and start using...

'''sh
from homehubRPi import []

'''

## 🤔 Documentation

To view documentation in your browser

1. **Clone the github repo**

```sh
git clone https://github.com/ngonimombeshora/homehubRPi
```

2. **Enter the docs folder**

```sh
cd docs/
```

3. **Open homehubRPi.html in your browser**
   And you're good to go. 🚀

**Alternatively**...

To view documentation, use pydocs. The following command starts a server at
http://localhost:33091/

```sh
python3 -m doc -b
```

And can be viewed at link: http://localhost:33091/ open link homehubRPi


