Package: plombery
PlomberyPython task scheduler with a user-friendly web UIOfficial website »GitHub·Report BugAbout The ProjectPlombery is a simple task scheduler for Python with a web UI and a REST API,
if you need to run and monitor recurring python scripts then it's
the right tool for you!This project is at its beginning, so it can be shaped and improved with
your feedback and help!
If you like it, star it 🌟! If you want a feature or find a bug, open an issue.Features⏰ Task scheduling based onAPScheduler(supports Interval, Cron and Date triggers)💻 Built-in Web interface, no HTML/JS/CSS coding required👩‍💻🐍 Pipelines and tasks are defined in pure Python🎛️ Pipelines can be parametrized viaPydantic👉 Pipelines can be run manually from the web UI🔐 Secured via OAuth2🔍 Debug each run exploring logs and output data📩 Monitor the pipelines and get alerted if something goes wrong💣 Use the REST API for advanced integrationsWhen you shouldn't use it:you need a lot of scalability and you want to run on a distributed systemyou want a no-code tool or you don't want to use Python(back to top)Built With(back to top)🚀 Getting StartedCheck the 👉official websiteto get started with Plombery.🎮 Try on GitHub CodespacesTry Plombery with some demo pipelines on GitHub Codespaces:Codespaces are development environments that run in the cloud so you
can run a project without cloning it, installing deps etc, here's an how
to:Go to the thelucafaggianelli/plomberyGitHub pageClick on the greenCodebutton on the top rightChoose theCodespacestabClick oncreate new codespace from mainor reuse an existing oneA new page will open atgithub.dev, wait for the environment buildOnce your codespace is ready you'll see an interface similar to VSCodeSome commands will be run in the terminal to build the frontend etc., wait for their completionIf everything went well, Plombery home page will be open in a new browser tabChanges in the Python code will be immediately reflected in the web page, like if you were developing
on your laptop🧐 Show me the codeThis is how it looks a minimalist pipeline:I know you want to see it!🛣 RoadmapSee theopen issuesfor a full list of proposed features (and known issues).(back to top)👩‍💻 ContributingContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make aregreatly appreciated.If 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".
Don't forget to give the project a star! Thanks again!Fork the ProjectCreate your Feature Branch (git checkout -b feature/AmazingFeature)Commit your Changes (git commit -m 'Add some AmazingFeature')Push to the Branch (git push origin feature/AmazingFeature)Open a Pull Request(back to top)DevelopmentClone a fork of this repo and start your dev environment.Create a python virtual environment:python-mvenv.venv# on Mac/Linuxsource.venv/bin/activate# on Win.venv/Script/activateand install the dependencies:pipinstall-rrequirements.txt
pipinstall-rrequirements-dev.txtfor development purposes, it's useful to run the example application:cdexamples/# Create a venv for the example apppython-mvenv.venvsource.venv/bin/activate
pipinstall-rrequirements

./run.sh# or ./run.ps1 on windowsThe React frontend is in thefrontend/folder, enter the folder
and install the dependencies:cdfrontend/# The project uses yarn as dependency manager, if you don't have# it, you must install it.# This command will install the deps:yarnrun the development server:yarndevDocumentationThe documentation website is based on MkDocs Material, the source code is in thedocs/folder and the config is in themkdocs.ymlfile.To run a local dev server, run:mkdocs serveTestingTests are based onpytest, to run the entire suite just run:pytestTo run tests coverage, run:coveragerun-mpytest
coveragereport-mLicenseDistributed under the MIT License. SeeLICENSE.txtfor more information.(back to top)ContactProject Link:https://github.com/lucafaggianelli/plombery(back to top)AcknowledgmentsPlombery is built on top of amazing techs:FastAPIPydanticAPSchedulerAppriseReactViteTremor(back to top)Star History