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.dev303

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.dev303
File Size Uploaded
skidward-0.0.1.dev303.tar.gz 27.1 kB Details

Built distribution (wheel)

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

Total release size: 44.1 kB

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

Download URL skidward-0.0.1.dev303.tar.gz
Size 27.1 kB
Tags Source
SHA-256 checksum
How to use checksums
9b0994d9b1e126c8b9745c60766770d5e165d645c309095850eba3ef1a94a3a4
BLAKE2b-256 checksum
How to use checksums
d3785d461d4bef894bd395a1c740731489ee8b8fb835522e1034ce54bbe407e8
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.dev303-py2.py3-none-any.whl

Download URL skidward-0.0.1.dev303-py2.py3-none-any.whl
Size 17.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
08b437045f8550bfd13babecbbd0abb8956f671e66bb8af7958ef6c990a309da
BLAKE2b-256 checksum
How to use checksums
82ccad20e3606c69da715ce2b54bd54069347e8f5ca3612c7d953cad9938f193
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.dev303 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