{"id":26219519,"url":"https://github.com/4211421036/githubiotpy","last_synced_at":"2025-04-16T01:57:46.716Z","repository":{"id":279529897,"uuid":"938788800","full_name":"4211421036/githubiotpy","owner":"4211421036","description":"GitHubIoT is a comprehensive toolkit designed to simplify the visualization of IoT (Internet of Things) data with seamless GitHub integration. The application provides an intuitive graphical interface for real-time data monitoring, analysis, and configuration","archived":false,"fork":false,"pushed_at":"2025-02-27T00:01:22.000Z","size":210,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-29T03:51:17.411Z","etag":null,"topics":["cli","esp32","esp8266","github-actions","github-iot","matplotlib","numpy","pypi-packages","python","tkinter"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/githubiot/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/4211421036.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-25T14:01:52.000Z","updated_at":"2025-02-27T00:01:25.000Z","dependencies_parsed_at":"2025-02-26T03:29:26.011Z","dependency_job_id":"c996ef29-09ea-4962-b63c-d387aac1d300","html_url":"https://github.com/4211421036/githubiotpy","commit_stats":null,"previous_names":["4211421036/githubiotpy"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4211421036%2Fgithubiotpy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4211421036%2Fgithubiotpy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4211421036%2Fgithubiotpy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4211421036%2Fgithubiotpy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/4211421036","download_url":"https://codeload.github.com/4211421036/githubiotpy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248688573,"owners_count":21145765,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","esp32","esp8266","github-actions","github-iot","matplotlib","numpy","pypi-packages","python","tkinter"],"created_at":"2025-03-12T14:18:26.223Z","updated_at":"2025-04-16T01:57:46.693Z","avatar_url":"https://github.com/4211421036.png","language":"Python","readme":"# GitHubIoT Documentation\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://4211421036.github.io/githubiotpy/img/GitHub%20IoT%20Logo.png\" alt=\"GitHubIoT Logo\"\u003e\n\u003c/p\u003e\n\nBefore Started Develoment this Application. Please Readme Wiki repository GitHub IoT for Arduino IDE Application at [https://github.com/4211421036/githubiot/wiki](https://github.com/4211421036/githubiot/wiki), following step by step. And The last, your can develoment webApp with GA  [https://github.com/marketplace/actions/generate-iot-dashboard](https://github.com/marketplace/actions/generate-iot-dashboard) automation step by step. Thank You!\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [Installation](#installation)\n- [Quick Start](#quick-start)\n- [Features](#features)\n- [Usage](#usage)\n  - [Command Line Interface](#command-line-interface)\n  - [Using as a Module](#using-as-a-module)\n- [Application Structure](#application-structure)\n  - [Core Components](#core-components)\n  - [User Interface](#user-interface)\n  - [Data Handling](#data-handling)\n- [Configuration](#configuration)\n  - [Configuration File](#configuration-file)\n  - [Runtime Configuration](#runtime-configuration)\n- [Customization](#customization)\n  - [Themes](#themes)\n  - [Chart Types](#chart-types)\n  - [Animation Settings](#animation-settings)\n- [Troubleshooting](#troubleshooting)\n  - [Common Issues](#common-issues)\n  - [Debug Mode](#debug-mode)\n- [API Reference](#api-reference)\n  - [Main Methods](#main-methods)\n  - [Data Processing Functions](#data-processing-functions)\n- [Contributing](#contributing)\n- [License](#license)\n- [Authors](#authors)\n\n## Introduction\n\nGitHubIoT is a comprehensive toolkit designed to simplify the visualization of IoT (Internet of Things) data with seamless GitHub integration. The application provides an intuitive graphical interface for real-time data monitoring, analysis, and configuration, making it ideal for both beginners and experienced developers working with IoT devices.\n\n\u003e [!Note]\n\u003e GitHubIoT is designed to work with JSON data feeds, making it compatible with most IoT platforms and REST APIs.\n\n## Installation\n\nYou can install GitHubIoT using pip:\n\n```bash\npip install githubiot\n```\n\nor using Docker command line:\n```bash\ndocker pull galihridhoutomo/githubiot\n```\n\n### Prerequisites\n\n- Python 3.7 or higher\n- Required dependencies:\n  - Matplotlib\n  - NumPy\n  - Requests\n  - TkInter\n\n\u003e [!Important]\n\u003e Make sure you have the latest version of pip to avoid compatibility issues.\n\n## Quick Start\n\nAfter installation, you can quickly start the application with default settings:\n\n```bash\ngithubiot --create-app\n```\n\nThis will launch the application with default configurations. For a customized setup:\n\n```bash\ngithubiot --name \"My IoT Dashboard\" --json-url \"https://my-iot-api.com/data\"\n```\n\nand the last step\n\n```bash\ngithubiot --run\n```\n\nif you build this app to .exe application Desktop. Can be interact CLI githubiot below\n\n```bash\ngithubiot --build\n```\n\n## Features\n\n- **Real-time Data Visualization**: Monitor IoT data streams in real-time\n- **Multiple Chart Types**: Support for various visualization methods\n- **Customizable Themes**: Choose from multiple built-in themes or create your own\n- **Animation Control**: Enable/disable animations for performance optimization\n- **Graph Export**: Save visualizations in various formats (PNG, PDF, etc.)\n- **Responsive Interface**: Adapts to different screen sizes\n- **JSON Data Integration**: Connect to any JSON data source\n- **Configurable Settings**: Customize application behavior through configuration files\n\n## Usage\n\n### Command Line Interface\n\nGitHubIoT provides a comprehensive command line interface for various operations:\n\n| Command | Description |\n|---------|-------------|\n| `githubiot --create-app` | Create a new application template |\n| `githubiot --build` | Build the application to an executable |\n| `githubiot --run` | Run the application |\n| `githubiot --json-url URL` | Set custom JSON URL |\n| `githubiot --name NAME` | Set custom application name |\n| `githubiot -v, --version` | Show version information |\n\n### Using as a Module\n\nYou can also integrate GitHubIoT into your own Python projects:\n\n```python\nimport githubiot\n\n# Start with custom parameters\ngithubiot.start(\n    name=\"My IoT Dashboard\",\n    url_json=\"https://api.example.com/data\",\n    icon=\"https://example.com/icon.ico\",\n    status=\"build\"  # or \"run\"\n)\n```\n\n## Application Structure\n\n### Core Components\n\nThe application is built around the `JSONGraphApp` class, which manages the following key aspects:\n\n1. **Configuration Management**: Loads and applies settings from a configuration file\n2. **UI Construction**: Creates the menu system and UI widgets\n3. **Data Handling**: Fetches and processes data from JSON sources\n4. **Graph Rendering**: Visualizes data using Matplotlib\n5. **Animation Control**: Manages real-time animation of data\n\n### User Interface\n\nThe UI consists of:\n\n- Main visualization area\n- Toolbar for common actions\n- Menu system with File, Options, and Help menus\n- Theme selection and customization options\n\n### Data Handling\n\nThe application can:\n\n- Connect to remote JSON data sources\n- Generate sample data when connection fails\n- Process and transform data for visualization\n- Refresh data on demand\n\n## Configuration\n\n### Configuration File\n\nGitHubIoT uses a `config.json` file for persistent settings:\n\n```json\n{\n  \"url\": \"https://api.example.com/data\",\n  \"app_name\": \"GitHubIoT App\"\n}\n```\n\n\u003e [!Warning]\n\u003e Do not manually edit the configuration file while the application is running. Use the application interface or CLI commands to modify settings.\n\n### Runtime Configuration\n\nThe application can detect and apply configuration changes at runtime. When you modify settings externally, the application will update automatically.\n\n## Customization\n\n### Themes\n\nGitHubIoT supports multiple visualization themes:\n\n- Default\n- Classic\n- Dark Background\n- GGPlot\n- Seaborn\n- Solarize Light\n- BMH\n- Tableau Colorblind-friendly\n- FiveThirtyEight\n- Custom themes\n\nTo cycle through themes, use the \"Change Theme\" option in the File menu.\n\n### Chart Types\n\nWhile the current implementation focuses on line charts for EM wave visualization, the architecture supports extending to other chart types:\n\n- Line charts\n- Bar charts\n- Scatter plots\n- Area charts\n\n### Animation Settings\n\nAnimation can be toggled on/off from the Options menu. This is particularly useful when:\n\n- Working with very large datasets\n- Running on resource-constrained devices\n- Generating static exports\n\n## Troubleshooting\n\n### Common Issues\n\n1. **Data Not Loading**\n   - Verify your internet connection\n   - Check that the JSON URL is correct and accessible\n   - Ensure the JSON format matches the expected structure\n\n2. **Application Crashes**\n   - Update to the latest version\n   - Check for conflicting Python packages\n   - Verify that all dependencies are installed correctly\n\n3. **Visualization Issues**\n   - Try changing the theme\n   - Restart the application\n   - Verify your data structure\n\n### Debug Mode\n\nFor advanced troubleshooting, you can run the application in debug mode:\n\n```bash\ngithubiot --debug\n```\n\nThis will provide additional console output to help diagnose issues.\n\n## API Reference\n\n### Main Methods\n\n| Method | Description |\n|--------|-------------|\n| `githubiot.start()` | Initializes and starts the application |\n| `githubiot.load_config()` | Loads configuration from file |\n| `githubiot.update_config()` | Updates configuration settings |\n| `githubiot.build()` | Builds executable version |\n\n### Data Processing Functions\n\n| Function | Description |\n|----------|-------------|\n| `load_data()` | Fetches data from JSON source |\n| `refresh_data()` | Updates data from source |\n| `generate_sample_data()` | Creates sample data for testing |\n| `create_graph()` | Renders visualization from data |\n\n## Contributing\n\nContributions to GitHubIoT are welcome! Please follow these steps:\n\n1. [Fork](https://github.com/4211421036/githubiotpy/fork) the repository\n2. Create a feature branch\n3. Commit your changes\n4. Push to the branch\n5. Open a Pull Request\n\nPlease ensure your code follows the project's coding standards and includes appropriate tests.\n\n## License\n\nThis project is licensed under the MIT LICENCE [https://github.com/4211421036/githubiotpy/LICENCE](https://github.com/4211421036/githubiotpy/LICENCE) - see the LICENSE file for details.\n\n## Authors\n\n1. GALIH RIDHO UTOMO\n2. Fionita Fahra Azzahra\n\n## Cite\nPlease cite this respotory, if your use in the publication\n\n```bibtex\n@misc{githubiot,\nauthor = {Utomo, Galih Ridho, Fionita Fahra Azzahra},\ntitle = {GitHub IoT a comprehensive toolkit designed to simplify the visualization of IoT (Internet of Things) data with seamless GitHub integration. The application provides an intuitive graphical interface for real-time data monitoring, analysis, and configuration, making it ideal for both beginners and experienced developers working with IoT devices microcontroler (ESP32 or ESP8266) realtime},\nyear = {2025},\nhowpublished = {\\url{https://hub.docker.com/r/galihridhoutomo/githubiot}},\nnote = {GitHub repository},\n}\n```\n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003eGitHubIoT - Building the Future with Integrated Microcontroller Solutions\u003c/strong\u003e\n\u003c/p\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F4211421036%2Fgithubiotpy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F4211421036%2Fgithubiotpy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F4211421036%2Fgithubiotpy/lists"}