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.defaultfile 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
Metadata
Release files for skidward 0.0.1.dev376
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| skidward-0.0.1.dev376.tar.gz | 58.9 kB | Without provenance | Details for skidward-0.0.1.dev376.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| skidward-0.0.1.dev376-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for skidward-0.0.1.dev376-py2.py3-none-any.whl |
Total release size: 77.7 kB
Release files / skidward-0.0.1.dev376.tar.gz
| Download URL | skidward-0.0.1.dev376.tar.gz |
|---|---|
| Size | 58.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fa944ca02400a0e05ec11a53039ff3f52a055c1291d756c07c1276f6a5715b59
|
|
BLAKE2b-256 checksum How to use checksums |
b5f4a697fb2b424d104a2c3def6e6283819eb08d714b82251a018ac622ffb7c2
|
| 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.dev376-py2.py3-none-any.whl
| Download URL | skidward-0.0.1.dev376-py2.py3-none-any.whl |
|---|---|
| Size | 18.8 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
372e02c4ef1b8be0d0206d117e9317fdaf7b208cbc2e1f43717b2bf4f03371d8
|
|
BLAKE2b-256 checksum How to use checksums |
53aec4337c85d5821ca4f98b73bc2ea6e7798cc485c44b02cb7fe977e55f4374
|
| 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
|
Security for skidward 0.0.1.dev376
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.