# 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)
Raw data
{
"_id": null,
"home_page": "https://github.com/gruvw/maison-jung",
"name": "maison-jung",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": null,
"author": "gruvw",
"author_email": "gruvw.dev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a9/e8/4687f126b15de2a3223e916b966f53119231fd03834e44bff7ecb17e73df/maison_jung-0.1.9.tar.gz",
"platform": null,
"description": "# Maison Jung\n\nThis is the python package that runs on the Raspberry Pi managing the custom made IOT in my house.\n\n## Usage\n\nThe package exposes a CLI: `maison-jung --help`\n\nIt requires multiple files to be inside a working directory in order to run properly:\n\n- _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, ...\n- _options.yml_: used to build the interactive inline keyboard menu on telegram\n- _schedules.yml_: defines the scheduled tasks\n- _database.json_: [TinyDB](https://github.com/msiemens/tinydb) database\n\n## To Do\n\n- [ ] Type hinting\n- [ ] Text files data in database table (ready for drop)\n- [ ] Flask server (website)\n",
"bugtrack_url": null,
"license": null,
"summary": "Custom home IOT server.",
"version": "0.1.9",
"project_urls": {
"Homepage": "https://github.com/gruvw/maison-jung"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e6c2ff3ab6e0a1ba366cf844b7b547c898d0c0adeea49f96beef909647356855",
"md5": "90980343342b614630328798f7e14dfc",
"sha256": "6988ce9335ee81316270d2809d21dc49da8e466a7596733828fe949bbedcd7a2"
},
"downloads": -1,
"filename": "maison_jung-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90980343342b614630328798f7e14dfc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 15890,
"upload_time": "2024-07-25T18:27:27",
"upload_time_iso_8601": "2024-07-25T18:27:27.757153Z",
"url": "https://files.pythonhosted.org/packages/e6/c2/ff3ab6e0a1ba366cf844b7b547c898d0c0adeea49f96beef909647356855/maison_jung-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a9e84687f126b15de2a3223e916b966f53119231fd03834e44bff7ecb17e73df",
"md5": "c2e2dfc1538574416b8bf7a6ae5b382a",
"sha256": "c227c95207f8839d853d39cbbf021db187ead71dbbf556b4e2d8525b5208b134"
},
"downloads": -1,
"filename": "maison_jung-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "c2e2dfc1538574416b8bf7a6ae5b382a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 11319,
"upload_time": "2024-07-25T18:27:29",
"upload_time_iso_8601": "2024-07-25T18:27:29.250099Z",
"url": "https://files.pythonhosted.org/packages/a9/e8/4687f126b15de2a3223e916b966f53119231fd03834e44bff7ecb17e73df/maison_jung-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-25 18:27:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gruvw",
"github_project": "maison-jung",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "maison-jung"
}
JSON
