https://github.com/softgeekro/roundbox
A small lightweight framework for IoT applications.
https://github.com/softgeekro/roundbox
applications home-assistant iot lightweight python python3 small
Last synced: 10 days ago
JSON representation
A small lightweight framework for IoT applications.
- Host: GitHub
- URL: https://github.com/softgeekro/roundbox
- Owner: SoftGeekRO
- License: gpl-3.0
- Created: 2022-04-04T10:25:46.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-09T05:39:11.000Z (over 2 years ago)
- Last Synced: 2025-09-14T23:01:58.482Z (9 months ago)
- Topics: applications, home-assistant, iot, lightweight, python, python3, small
- Language: Python
- Homepage: https://soulraven.github.io/roundbox/
- Size: 979 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
⚡ RoundBox
==========
[](https://github.com/psf/black)
[](https://img.shields.io/github/workflow/status/soulraven/roundbox/merge-to-main)
[](https://pypi.org/project/roundbox/)
[](https://img.shields.io/github/license/soulraven/roundbox)
***
A small lightweight framework for IoT applications, with main goal to not reinvent the wheel every time when a small
project for IoT device is needed.
The framework contains all tools necessary to bootstrap and run a command a single time or using linux crontab.
You can create apps as many as you like and use them for your proper necessity, but consider that each app is liake a
small container with logic.
Each app has the possibility to host specific commands that will be available when running manage.py.
### 🎈 Special thanks 🎈
To build this framework I have used code inspired by the [Django](https://github.com/django/django) project and also
from [Home Assistant](https://github.com/home-assistant/core) project.
Both projects have a strong code base and lightweight and port on different projects.
***
### 🔧 Installation
The easy way to install RoundBox framework is with [pip]
```bash
$ pip install roundbox
```
If you want to install RoundBox from GitHub use:
```bash
$ pip install git+https://github.com/soulraven/roundbox.git
```
For more detailed install instructions see how [Install] and configure the framework.
***
### ➿ Variables
- set the ROUNDBOX_COLORS environment variable to specify the palette you want to use. For example,
to specify the light palette under a Unix or OS/X BASH shell, you would run the following at a command prompt:
```bash
export ROUNDBOX_COLORS="light"
```
***
### 🖇 Library used
A more detailed list you will find here: [Libraries](https://soulraven.github.io/roundbox/libraries/)
***
### 🌍 Contributions
Contributions of all forms are welcome :)
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## 📝 License
This project is licensed under [GPLv3].
## 👀 Author
Zaharia Constantin, my [GitHub profile] and [GitHub Page]
[GitHub profile]: https://github.com/soulraven/
[Github Page]: https://soulraven.github.io/
[GNU General Public License]: https://www.gnu.org/licenses/quick-guide-gplv3.html
[pip]: https://pip.pypa.io/en/stable/
[GPLv3]: https://soulraven.github.io/roundbox/license
[Install]: https://soulraven.github.io/roundbox/user-guide/topics/install