https://github.com/gruvw/maison-jung

The python package that runs on the Raspberry Pi managing the custom-made IOT in my house
https://github.com/gruvw/maison-jung

Last synced: 17 days ago
JSON representation

The python package that runs on the Raspberry Pi managing the custom-made IOT in my house

• Host: GitHub
• URL: https://github.com/gruvw/maison-jung
• Owner: gruvw
• Created: 2021-08-05T14:10:10.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-26T08:35:51.000Z (5 months ago)
• Last Synced: 2024-12-14T14:08:40.237Z (23 days ago)
• Language: Python
• Homepage:
• Size: 323 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Maison Jung

This is the python package that runs on the Raspberry Pi managing the custom made IOT in my house.

## Usage

The package exposes a CLI: `maison-jung --help`

It requires multiple files to be inside a working directory in order to run properly:

- _config.yml_: where are stored API keys (for the [telegram bot](https://github.com/python-telegram-bot/python-telegram-bot) and [Adafruit IO](https://io.adafruit.com/Dedelejardinier/dashboards)), all the [wemos](https://www.wemos.cc/) ips, ...

- _options.yml_: used to build the interactive inline keyboard menu on telegram

- _schedules.yml_: defines the scheduled tasks

- _database.json_: [TinyDB](https://github.com/msiemens/tinydb) database

## To Do

- [ ] Type hinting

- [ ] Text files data in database table (ready for drop)

- [ ] Flask server (website)