Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 3 KB

README.md

File metadata and controls

86 lines (55 loc) · 3 KB

⚡ RoundBox

Code style: black PyPI GitHub release (latest by date) Build status Supported Python versions License


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 project and also from Home Assistant 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

$ pip install roundbox

If you want to install RoundBox from GitHub use:

$ 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:
export ROUNDBOX_COLORS="light"

🖇 Library used

A more detailed list you will find here: 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