{"id":26423585,"url":"https://github.com/iamdyeus/tkreload","last_synced_at":"2025-03-18T02:53:43.850Z","repository":{"id":258753505,"uuid":"875125742","full_name":"iamDyeus/tkreload","owner":"iamDyeus","description":"auto reloads your tkinter app whenever file changes are detected 🐍","archived":false,"fork":false,"pushed_at":"2024-10-24T14:11:29.000Z","size":1567,"stargazers_count":10,"open_issues_count":2,"forks_count":7,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-24T19:55:11.148Z","etag":null,"topics":["customtkinter","developer-tools","devtool","gui-tool","hacktoberfest","hacktoberfest-accpeted","hacktoberfest2024","hotreloading","opensourceforgood","python","python-libary","tkinter"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/tkreload/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iamDyeus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2024-10-19T06:52:30.000Z","updated_at":"2024-10-24T14:06:52.000Z","dependencies_parsed_at":"2024-10-25T21:36:06.362Z","dependency_job_id":null,"html_url":"https://github.com/iamDyeus/tkreload","commit_stats":null,"previous_names":["iamdyeus/tkreload"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iamDyeus%2Ftkreload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iamDyeus%2Ftkreload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iamDyeus%2Ftkreload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iamDyeus%2Ftkreload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iamDyeus","download_url":"https://codeload.github.com/iamDyeus/tkreload/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244147352,"owners_count":20405940,"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":["customtkinter","developer-tools","devtool","gui-tool","hacktoberfest","hacktoberfest-accpeted","hacktoberfest2024","hotreloading","opensourceforgood","python","python-libary","tkinter"],"created_at":"2025-03-18T02:53:43.299Z","updated_at":"2025-03-18T02:53:43.820Z","avatar_url":"https://github.com/iamDyeus.png","language":"Python","readme":"\u003cdiv align=\"center\"\u003e\n\n# ![TkReload-Logo](https://github.com/iamDyeus/tkreload/blob/main/.assets/logo/svg/logo_light.svg?raw=true)\n\n![Static Badge](https://img.shields.io/badge/pip_install-tkreload-purple)\n![Static Badge](https://img.shields.io/badge/Language-Python-red)\n![GitHub last commit](https://img.shields.io/github/last-commit/iamDyeus/tkreload)\n\n\u003ch3\u003e\n\u003ccode\u003etkreload\u003c/code\u003e | Automated Tkinter App Reloading for a Smoother Development Workflow\n\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\nEffortlessly reload Tkinter-based Python applications in the terminal, saving valuable development time.\n\u003c/p\u003e\n\n[Installation](#installation) • [Usage](#usage) • [Features](#features) • [Testing](#testing) • [Contributing](#contributing) • [License](#license)\n\n\u003c/div\u003e\n\n---\n\n## 🚀 Problem Statement\n\nFor developers, frequent manual restarts of terminal applications during development can add up quickly, especially in complex Tkinter projects that require regular updates. `tkreload` provides a solution to this by automating the reload process, resulting in significant time savings.\n\n### ⏳ Estimated Time Saved with tkreload\n\nImagine restarting your terminal application **15 times daily**, with each reload taking **30 seconds**. That’s approximately **7.5 minutes daily** or about **3 hours per month**. `tkreload` helps avoid this productivity drain.\n\n---\n\n## 🔍 Solution Overview\n\n`tkreload` automates reloading for terminal-based Python applications, designed specifically for **Tkinter**. By eliminating the need for manual restarts, it streamlines the development process, saving developers valuable time and enhancing productivity.\n\n**Without tkreload:**\n![Without tkreload](https://github.com/iamDyeus/tkreload/blob/main/.assets/without.gif?raw=true)\n\n**With tkreload:**\n![With tkreload](https://github.com/iamDyeus/tkreload/blob/main/.assets/with.gif?raw=true)\n\n---\n\n## 🛠️ Getting Started\n\n### Prerequisites\n- **Python** 3.9+\n- **pip** for dependency management\n\n### Installation\n\n#### 1. Clone the Repository\n```sh\ngit clone https://github.com/iamDyeus/tkreload.git\ncd tkreload\n```\n#### 2. Create and activate a virtual environment:\n```sh\npython -m venv venv\nsource venv/bin/activate  # On Windows, use `venv\\Scripts\\activate`\n```\n\n3. Install tkreload (in editable mode):\n```sh\npip install -e.[test]\n```\n\n# Usage\n\nTo run the app with `tkreload`, use the following command in your terminal:\n\n```bash\ntkreload your_app.py\n```\n\nNow, whenever you save changes to your script, tkreload will automatically reload your application.\n\n## 🌟 Features\n\n- **Automatic Reloading:** Automatically restarts Tkinter apps upon file changes.\n- **Command-Based Control:**\n  - **`H`:** View help commands\n  - **`R`:** Restart the application\n  - **`A`:** Toggle auto-reload\n  - **`Ctrl + C`:** Exit the application\n- **Real-Time Feedback:** Uses `rich` for styled console feedback and progress indicators.\n\n\n\n## Testing\nTo verify tkreload functionality, follow these steps:\n\n1.Install Testing Dependencies: Make sure all testing libraries are installed as per the requirements.txt file.\n\n2.Run Tests Using Pytest\n```bash\npytest -v\n```\nThis will run the test suite and confirm tkreload is working as expected.\n\n# Contributing\n\nContributions are welcome and greatly appreciated! Here's how you can contribute:\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n![COMMUNISM](https://github.com/iamDyeus/tkreload/blob/main/.assets/communism.png?raw=true)\n\n# License\n\nDistributed under the Apache-2.0 License. See [`LICENSE`](LICENSE) for more information.\n\n# Acknowledgments\n- Inspired by the need for efficient development workflows\n- Thanks to all contributors and supporters of this project\n\n## Star History\n[![Star History Chart](https://api.star-history.com/svg?repos=iamDyeus/tkreload\u0026type=Date)](https://star-history.com/#iamDyeus/tkreload\u0026Date)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiamdyeus%2Ftkreload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiamdyeus%2Ftkreload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiamdyeus%2Ftkreload/lists"}