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

Contributing to the documentation

All documentation is built with Sphix and can be found in the docs folder, with pages in docs/src and images located in docs/src/images.

Build the docs
```
 $ cd docs
 $ make html
```
Open the result in a web browser (here Firefox is used)
```
  $ firefox _build/html/index.html
```

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

Development Status
- 4 - Beta
License
- OSI Approved :: MIT License
Operating System
- POSIX
Programming Language

Release files for skidward 0.0.1.dev412

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.dev412
File	Size	Uploaded
skidward-0.0.1.dev412.tar.gz	62.5 kB	Mar 25, 2019	Details

Built distribution (wheel)

Table of built distributions (wheels) for skidward 0.0.1.dev412
File	Interpreter	ABI	Platform	Reset
skidward-0.0.1.dev412-py2.py3-none-any.whl 21.0 kB Mar 25, 2019	Python 2, Python 3	none	any	Details

Total release size: 83.5 kB

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

Download URL	skidward-0.0.1.dev412.tar.gz
Size	62.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`2ac16427128f39a44361d0689dfb2b2e4e43b609ffafd8d7f40f7c6b9f2f8ef8`
BLAKE2b-256 checksum How to use checksums	`57392cbc11f5533adacb73a97553ae501e524c0e05ccc793e0bb02fd5023d3dc`
Upload date	Mar 25, 2019
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.dev412-py2.py3-none-any.whl

Download URL	skidward-0.0.1.dev412-py2.py3-none-any.whl
Size	21.0 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`c1e86cfbe22b5297c12eed5178523d3e4c68f1a46c6c72e69bfdb5c3709d9722`
BLAKE2b-256 checksum How to use checksums	`a9b4bc41d85807299c99c7cbe13e0cec6abc498d7802d39d2afa32bff5c0f071`
Upload date	Mar 25, 2019
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`