Serverless Orchestrator of Serverless Workers (SOSW)
sosw is a set of tools for orchestrating asynchronous invocations of AWS Lambda Workers.
Detailed documentation can be found on Read The Docs: sosw.readthedocs.io
Dependencies
- Python 3.6
- boto3 (AWS SDK for Python)
Development
Getting Started
Assuming you have Python 3.6 and pipenv installed. Create a new virtual environment:
$ pipenv shell
Now install the required dependencies for development:
$ pipenv sync --dev
Running Tests
Running unit tests:
$ pytest ./sosw/test/suite_3_6_unit.py
Contribution Guidelines
Release cycle
- We follow both Semantic Versioning pattern and PEP440 recommendations where comply
- Master branch commits (merges) are automatically packaged and published to PyPI.
- Branches for planned staging versions follow the pattern:
X_Y_Z(Major.Minor.Micro) - Make your pull requests to the latest staging branch (with highest number)
- Latest documentation is compiled from branch
docme. It should be up to date with latest staging branch, not the master. Make PRs with documentation change directly todocme.
Code formatting
Follow PEP8, but:
- both classes and functions are padded with 2 empty lines
- dictionaries are value-alligned
Initialization
- Fork the repository: https://github.com/bimpression/sosw
- Register Account in AWS: SignUp
- Run
pipenv sync –devto setup your virtual environment and download the required dependencies - Create DynamoDB Tables:
- You can find the CloudFormation template for the databases in the example.
- If you are not familiar with CloudFormation, we highly recommend at least learning the basics from the tutorial.
- Create Sandbox Lambda with Scheduler
- Play with it.
- Read the Documentation Convention.
Building the docs
Sphinx is used for building documentation. To build HTML documentation locally, use:
$ sphinx-build -ab html ./docs ./sosw-rtd
You can then use the built in Python web server to view the html version directly from localhost in your preferred browser.
$ cd sosw-rtd
$ python -m http.server
Metadata
Release files for sosw 0.7.9
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 | |
|---|---|---|---|---|
| sosw-0.7.9.tar.gz | 76.6 kB | Without provenance | Details |
Release files / sosw-0.7.9.tar.gz
| Download URL | sosw-0.7.9.tar.gz |
|---|---|
| Size | 76.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
00fa173487fa20165b3541d8b3b4b06b7d582adf77ce0180cb82d618f6956c46
|
|
BLAKE2b-256 checksum How to use checksums |
f7324bf1950554f3cc143c09b075aebf9518a490deb54eb09abba65a6b8b28e7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.3
|
Security for sosw 0.7.9
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.