Python task scheduler with a user-friendly web UI
MIT License
Plombery 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.
When you shouldn't use it:
Check the 👉 official website to get started with Plombery.
Try 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:
github.dev
, wait for the environment buildThis is how it looks a minimalist pipeline:
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly 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!
git checkout -b feature/AmazingFeature
)git commit -m 'Add some AmazingFeature'
)git push origin feature/AmazingFeature
)Clone a fork of this repo and start your dev environment.
Create a python virtual environment:
python -m venv .venv
# on Mac/Linux
source .venv/bin/activate
# on Win
.venv/Script/activate
and install the dependencies:
pip install -r requirements.txt
pip install -r requirements-dev.txt
for development purposes, it's useful to run the example application:
cd examples/
# Create a venv for the example app
python -m venv .venv
source .venv/bin/activate
pip install -r requirements
./run.sh
# or ./run.ps1 on windows
The React frontend is in the frontend/
folder, enter the folder
and install the dependencies:
cd frontend/
# The project uses yarn as dependency manager, if you don't have
# it, you must install it.
# This command will install the deps:
yarn
run the development server:
yarn dev
The documentation website is based on MkDocs Material, the source code is in the
docs/
folder and the config is in the mkdocs.yml
file.
To run a local dev server, run:
mkdocs serve
Tests are based on pytest
, to run the entire suite just run:
pytest
To run tests coverage, run:
coverage run -m pytest
coverage report -m
Distributed under the MIT License. See LICENSE.txt
for more information.
Project Link: https://github.com/lucafaggianelli/plombery
Plombery is built on top of amazing techs: