Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Skidward

Scheduler For Python Scripts

Prerequisites

The project was built with Python 3.6.7 and requires a working Postgres and Redis setup.
Please refer to your operating system's specific installation instructions per package.

  • Python 3.6.7
  • Postgres (tested on 11 and up)
  • Redis (tested on 5 and up)

Installation

  • Install the requirements

      $ pip install -r requirements.txt
    
  • Create user (called a 'role') in postgres and give it ownership over the new db Note: It is recommended to create a user with a password, even for development purposes.

      $ createuser skidwarduser
      $ createdb skidwarddb -O skidwarduser
    

The application uses environment variables to offer flexible configuration options.
Before using the application, review the configuration in the .env file to match your desired setup.
A typical connectionstring looks like this: SQLALCHEMY_DATABASE_URI='postgresql://USER:PASSWORD@localhost/DATABASENAME'

  • Copy the .env.default file to the skidward module and rename to .env.

      $ cp .env.default skidward/.env
    
  • Publish available workers on the namespace in the database

      $ python -m skidward publish-workers
    
  • Create an admin user for use in the application

      $ python -m skidward create-admin USER_EMAIL
    

Development

  • Install the development requirements

      $ pip install -r requirements-dev.txt
    
  • Set up the git pre-commit hook required for development

      $ pre-commit install
    

Optional: If you want to install demo-workers from a proxy, navigate to the root of your virtual environment and create a pip.conf file.

    $ touch pip.conf
    $ echo "[global]" >> pip.conf
    $ echo "extra-index-url = URL_TO_PROXY" >> pip.conf

Running the application

There's an admin interface provided to communicate with the application,
and then there's the backend side doing the operations.

1. Web interface

  • Point Flask to the location of the web application

      $ export FLASK_APP=skidward.web
    
  • Run the default setup (in the same session as the previous command)

      $ flask run
    

2. Scheduler side

  • Start a new scheduler process (in the fore- or background)

      $ python -m skidward start-scheduler        # Runs in your session
      $ python -m skidward start-scheduler true   # Creates a new process running in the background
    

Release files for skidward 0.0.1.dev319

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for skidward 0.0.1.dev319
File Size Uploaded
skidward-0.0.1.dev319.tar.gz 27.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for skidward 0.0.1.dev319
File Interpreter ABI Platform
skidward-0.0.1.dev319-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 45.4 kB

Release files / skidward-0.0.1.dev319.tar.gz

Download URL skidward-0.0.1.dev319.tar.gz
Size 27.9 kB
Tags Source
SHA-256 checksum
How to use checksums
de705f70c89afdcb37151c1bcb29429d80c993c33e4e5adbbd8a98eeddba35ed
BLAKE2b-256 checksum
How to use checksums
8ce133c6aed6e77c9f0616e99e474c91faced8a0454712506309446aed72822e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.7

Release files / skidward-0.0.1.dev319-py2.py3-none-any.whl

Download URL skidward-0.0.1.dev319-py2.py3-none-any.whl
Size 17.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
34df4e751b8d7454333d0a3841ccb849467e467e7882105543d8e90437f71297
BLAKE2b-256 checksum
How to use checksums
25fac1c0a5b920efc8f69226f9779717414770d8303c3a832cb64245e4dd137c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.7

Release history Release notifications | RSS feed

This release

0.0.1.dev319 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page