Skip to main content

Schedule async tasks and manage them using a REST API or WEB UI

Project description

aiocronjob

Join the chat at https://gitter.im/aiocronjob/community PyPI - Python Version PyPI PyPI - License GitHub last commit PyPI - Status Tests Codecov

Schedule and run asyncio coroutines and manage them from a web interface or programmatically using the rest api.

Requires python >= 3.8

How to install

pip3 install aiocronjob

Usage example

See examples/simple_tasks.py

After running the app, the FastAPI server runs at localhost:5000.

Web Interface

Open localhost:5000 in your browser:

screenshot-actionmenu screenshot-all

Rest API

Open localhost:5000/docs for endpoints docs.

EndpointsScreenshot

curl example:

$ curl http://0.0.0.0:5000/api/jobs
[
  {
    "name": "First task",
    "next_run_in": "3481.906931",
    "last_status": "pending",
    "enabled": "True",
    "crontab": "22 * * * *",
    "created_at": "2020-06-06T10:20:25.118630+00:00",
    "started_at": null,
    "stopped_at": null
  },
  {
    "name": "Second task",
    "next_run_in": "3541.904723",
    "last_status": "error",
    "enabled": "True",
    "crontab": "23 * * * *",
    "created_at": "2020-06-06T10:20:25.118661+00:00",
    "started_at": "2020-06-06T10:23:00.000906+00:00",
    "stopped_at": "2020-06-06T10:23:15.004351+00:00"
  }
]

Development

Requirements:

  • Python >= 3.8 and PDM for backend
  • npm for frontend

The frontend is a separate Single Page Application (SPA), so the backend does not depend on it. It just calls the backend's API endpoints.

Install backend dependencies (Python)

$ git clone https://github.com/devtud/aiocronjob.git

$ cd aiocronjob

$ pdm sync

Run backend tests

pdm run coverage run -m unittest discover

pdm run coverage report -m

Run backend example

pdm run python examples/simple_tasks.py

uvicorn will run the FastAPI app at http://localhost:5000.

Install frontend dependencies (React SPA)

Open another terminal tab in the project root.

$ cd src/webapp

$ npm i

Run frontend tests

npm test

Let frontend know about backend

Create .env file with the content from .env.example file to let the frontend know that the backend is running at http://localhost:5000.

cp .env.example .env

Serve frontend

npm start

A React app starts at http://localhost:3000.

You should now be able to view the example jobs in your browser at http://localhost:3000.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiocronjob-0.4.3.tar.gz (745.6 kB view hashes)

Uploaded source

Built Distribution

aiocronjob-0.4.3-py3-none-any.whl (756.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page