{"id":13475432,"url":"https://github.com/lucafaggianelli/plombery","last_synced_at":"2025-05-14T20:02:24.062Z","repository":{"id":145271157,"uuid":"609578595","full_name":"lucafaggianelli/plombery","owner":"lucafaggianelli","description":"Python task scheduler with a user-friendly web UI","archived":false,"fork":false,"pushed_at":"2025-03-11T11:25:49.000Z","size":4538,"stargazers_count":534,"open_issues_count":91,"forks_count":74,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-06T20:01:35.477Z","etag":null,"topics":["apscheduler","hacktoberfest","orchestrator","pipeline","python","react","task-scheduler","tremor","typescript"],"latest_commit_sha":null,"homepage":"http://lucafaggianelli.com/plombery/","language":"TypeScript","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/lucafaggianelli.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2023-03-04T15:52:08.000Z","updated_at":"2025-04-06T07:37:40.000Z","dependencies_parsed_at":"2023-10-05T04:57:50.792Z","dependency_job_id":"0acf925b-6783-4cde-b742-468fa173f48e","html_url":"https://github.com/lucafaggianelli/plombery","commit_stats":{"total_commits":341,"total_committers":4,"mean_commits":85.25,"dds":"0.16422287390029322","last_synced_commit":"b3ad55efc6840f062bd585e69d04277f0f98afa8"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucafaggianelli%2Fplombery","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucafaggianelli%2Fplombery/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucafaggianelli%2Fplombery/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucafaggianelli%2Fplombery/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lucafaggianelli","download_url":"https://codeload.github.com/lucafaggianelli/plombery/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248789095,"owners_count":21161774,"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":["apscheduler","hacktoberfest","orchestrator","pipeline","python","react","task-scheduler","tremor","typescript"],"created_at":"2024-07-31T16:01:20.324Z","updated_at":"2025-04-13T22:19:04.592Z","avatar_url":"https://github.com/lucafaggianelli.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003c!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 --\u003e\n\n\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n[![PyPI Version][pypi-shield]][pypi-url]\n[![Code Climate][CodeClimate-shield]][CodeClimate-url]\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n\u003ch3 align=\"center\"\u003ePlombery\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    Python task scheduler with a user-friendly web UI\n    \u003cbr /\u003e\n    \u003ca href=\"https://lucafaggianelli.github.io/plombery/\"\u003e\u003cstrong\u003eOfficial website »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/lucafaggianelli/plombery\"\u003eGitHub\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/lucafaggianelli/plombery/issues\"\u003eReport Bug\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\nPlombery is a simple task scheduler for Python with a web UI and a REST API,\nif you need to run and monitor recurring python scripts then it's\nthe right tool for you!\n\n\u003cfigure\u003e\n  \u003cimg src=\"https://github.com/lucafaggianelli/plombery/raw/main/docs/assets/images/screenshot.png\" alt=\"Plombery Screen Shot\"\u003e\n\u003c/figure\u003e\n\n\u003e This project is at its beginning, so it can be shaped and improved with\n\u003e your feedback and help!\n\u003e If you like it, star it 🌟! If you want a feature or find a bug, open an issue.\n\n## Features\n\n- ⏰ Task scheduling based on [APScheduler](https://github.com/agronholm/apscheduler) (supports Interval, Cron and Date triggers)\n- 💻 Built-in Web interface, no HTML/JS/CSS coding required\n- 👩‍💻🐍 Pipelines and tasks are defined in pure Python\n- 🎛️ Pipelines can be parametrized via [Pydantic](https://docs.pydantic.dev/)\n- 👉 Pipelines can be run manually from the web UI\n- 🔐 Secured via OAuth2\n- 🔍 Debug each run exploring logs and output data\n- 📩 Monitor the pipelines and get alerted if something goes wrong\n- 💣 Use the REST API for advanced integrations\n\nWhen you shouldn't use it:\n\n- you need a lot of scalability and you want to run on a distributed system\n- you want a no-code tool or you don't want to use Python\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Built With\n\n[![Python][Python]][Python-url]\n[![TypeScript][TypeScript]][TypeScript-url]\n[![React][React.js]][React-url]\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## 🚀 Getting Started\n\nCheck the 👉 [official website](https://lucafaggianelli.github.io/plombery/)\nto get started with Plombery.\n\n## 🎮 Try on GitHub Codespaces\n\nTry Plombery with some demo pipelines on GitHub Codespaces:\n\n\u003cfigure align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/lucafaggianelli/plombery/raw/main/docs/assets/images/codespaces.png\" alt=\"Get Started on Codespaces\"\u003e\n\u003c/figure\u003e\n\nCodespaces are development environments that run in the cloud so you\ncan run a project without cloning it, installing deps etc, here's an how\nto:\n\n- Go to the the [lucafaggianelli/plombery](https://github.com/lucafaggianelli/plombery) GitHub page\n- Click on the green **Code** button on the top right\n- Choose the **Codespaces** tab\n- Click on *create new codespace from main* or reuse an existing one\n- A new page will open at `github.dev`, wait for the environment build\n- Once your codespace is ready you'll see an interface similar to VSCode\n- Some commands will be run in the terminal to build the frontend etc., wait for their completion\n- If everything went well, Plombery home page will be open in a new browser tab\n- Changes in the Python code will be immediately reflected in the web page, like if you were developing\n  on your laptop\n\n## 🧐 Show me the code\n\nThis is how it looks a minimalist pipeline:\n\n\u003cfigure align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/lucafaggianelli/plombery/raw/main/docs/assets/images/minimal-code.png\" alt=\"Minimal code\" width=\"80%\"\u003e\n  \u003cfigcaption\u003eI know you want to see it!\u003c/figcaption\u003e\n\u003c/figure\u003e\n\n\u003c!-- ROADMAP --\u003e\n\n## 🛣 Roadmap\n\nSee the [open issues](https://github.com/lucafaggianelli/plombery/issues) for a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## 👩‍💻 Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\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\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Development\n\nClone a fork of this repo and start your dev environment.\n\nCreate a python virtual environment:\n\n```sh\npython -m venv .venv\n# on Mac/Linux\nsource .venv/bin/activate\n# on Win\n.venv/Script/activate\n```\n\nand install the dependencies:\n\n```sh\npip install -r requirements.txt\npip install -r requirements-dev.txt\n```\n\nfor development purposes, it's useful to run the example application:\n\n```sh\ncd examples/\n\n# Create a venv for the example app\npython -m venv .venv\nsource .venv/bin/activate\npip install -r requirements\n\n./run.sh\n# or ./run.ps1 on windows\n```\n\nThe React frontend is in the `frontend/` folder, enter the folder\nand install the dependencies:\n\n```sh\ncd frontend/\n# The project uses yarn as dependency manager, if you don't have\n# it, you must install it.\n# This command will install the deps:\nyarn\n```\n\nrun the development server:\n\n```sh\nyarn dev\n```\n\n### Documentation\n\nThe documentation website is based on MkDocs Material, the source code is in the\n`docs/` folder and the config is in the `mkdocs.yml` file.\n\nTo run a local dev server, run:\n\n```\nmkdocs serve\n```\n\n### Testing\n\nTests are based on `pytest`, to run the entire suite just run:\n\n```sh\npytest\n```\n\nTo run tests coverage, run:\n\n```sh\ncoverage run -m pytest\ncoverage report -m\n```\n\n\u003c!-- LICENSE --\u003e\n\n## License\n\nDistributed under the MIT License. See `LICENSE.txt` for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTACT --\u003e\n\n## Contact\n\nProject Link: [https://github.com/lucafaggianelli/plombery](https://github.com/lucafaggianelli/plombery)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- ACKNOWLEDGMENTS --\u003e\n\n## Acknowledgments\n\nPlombery is built on top of amazing techs:\n\n- [FastAPI](https://fastapi.tiangolo.com/)\n- [Pydantic](https://docs.pydantic.dev/)\n- [APScheduler](https://apscheduler.readthedocs.io/)\n- [Apprise](https://github.com/caronc/apprise)\n- [React](https://react.dev/)\n- [Vite](https://vitejs.dev/)\n- [Tremor](https://www.tremor.so/)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Star History\n\n\u003ca href=\"https://star-history.com/#lucafaggianelli/plombery\u0026Date\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://api.star-history.com/svg?repos=lucafaggianelli/plombery\u0026type=Date\u0026theme=dark\" /\u003e\n    \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://api.star-history.com/svg?repos=lucafaggianelli/plombery\u0026type=Date\" /\u003e\n    \u003cimg alt=\"Star History Chart\" src=\"https://api.star-history.com/svg?repos=lucafaggianelli/plombery\u0026type=Date\" /\u003e\n  \u003c/picture\u003e\n\u003c/a\u003e\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n\n[contributors-shield]: https://img.shields.io/github/contributors/lucafaggianelli/plombery.svg?style=for-the-badge\n[contributors-url]: https://github.com/lucafaggianelli/plombery/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/lucafaggianelli/plombery.svg?style=for-the-badge\n[forks-url]: https://github.com/lucafaggianelli/plombery/network/members\n[stars-shield]: https://img.shields.io/github/stars/lucafaggianelli/plombery.svg?style=for-the-badge\n[stars-url]: https://github.com/lucafaggianelli/plombery/stargazers\n[issues-shield]: https://img.shields.io/github/issues/lucafaggianelli/plombery.svg?style=for-the-badge\n[issues-url]: https://github.com/lucafaggianelli/plombery/issues\n[license-shield]: https://img.shields.io/github/license/lucafaggianelli/plombery.svg?style=for-the-badge\n[license-url]: https://github.com/lucafaggianelli/plombery/blob/master/LICENSE\n[product-screenshot]: images/screenshot.png\n[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge\u0026logo=react\u0026logoColor=61DAFB\n[React-url]: https://reactjs.org/\n[Python]: https://img.shields.io/badge/Python-3776AB?style=for-the-badge\u0026logo=python\u0026logoColor=yellow\n[Python-url]: https://www.python.org/\n[TypeScript]: https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge\u0026logo=typescript\u0026logoColor=white\n[TypeScript-url]: https://www.typescriptlang.org/\n[pypi-shield]: https://img.shields.io/pypi/v/plombery.svg?style=for-the-badge\n[pypi-url]: https://pypi.python.org/pypi/plombery\n[CodeClimate-shield]: https://codeclimate.com/github/lucafaggianelli/plombery.png?style=for-the-badge\n[CodeClimate-url]: https://codeclimate.com/github/lucafaggianelli/plombery\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucafaggianelli%2Fplombery","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flucafaggianelli%2Fplombery","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucafaggianelli%2Fplombery/lists"}