Skip to main content

Schedule pypyr pipelines with apscheduler and control them via REST. The API interface is provided by Zalando's connexion.

Project description

pypyr-scheduler 📓

Logo

Schedule pypyr pipelines with apscheduler and control them via REST. The API interface is provided by connexion.

Travis (.org) Coveralls github Read the Docs GitHub

Documentation status

This documentation is in a very early stage and many things could be missing or wrong. Please rely on the code for now.

Install

Make a new venv, activate it, clone the repo, run pip install. No pypi release yet. We recommend using pipenv, which makes it easy to run commands inside a virtual env without the need to create or activate it:

pip install --user pipenv  # only needed once per python install
pipenv install
pipenv run pyrsched

Usage

Development / Testing

Run python -m pyrsched. Browse to http://localhost:5000/ui/. This uses the builtin webserver from Flask, which is not recommended for production use.

Production deployment

For example, the command line for uwsgi would look like follows:

uwsgi --http 127.0.0.1:3031 -w pyrsched.wsgi --enable-threads

The switch --enable-threads is necessary, if you intend to use the apscheduler.executors.pool:ThreadPoolExecutor (which is default).

Note that the command line switches for the hostname and port number are not used if served via wsgi, these values are provided to your wsgi server externally (see the --http-switch above).

Documentation

Detailed documentaion is available on ReadThedocs. It is generated from the docs/source folder in this repository. Feel free to send a PR is you find any typos.

Development

The API schema should be compliant to the OpenAPI 3.0.0 specification.

Quick links

Related projects

Flask-APScheduler provides a similar way to run job within flask as server. It even provides a REST-API. Try this if you don't need the functionality of pypyr.

Project details


Download files

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

Files for pypyr-scheduler, version 1.0.5
Filename, size File type Python version Upload date Hashes
Filename, size pypyr_scheduler-1.0.5-py3-none-any.whl (18.1 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pypyr-scheduler-1.0.5.tar.gz (13.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page