scheduler for python scripts
Project description
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for skidward-0.0.1.dev398-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb81bf5a4cf042a0fe07fc67f0309c5e7cb47b567bfeaf0b4be6380784b37e4b |
|
MD5 | 9d587c627e7f5e49fdc8745dd9fbd3e1 |
|
BLAKE2b-256 | 7c1a8cd3600d08cc015f299ad9b9c6e325666a48f45d40b97c22a6c5067ee87f |