Serverless Orchestrator of Serverless Workers

sosw is a set of serverless tools for orchestrating asynchronous invocations of AWS Lambda Functions (Workers).

Documentation

https://docs.sosw.app

Essential Workflows

Dependencies

• Python 3.8 | 3.9 | 3.10 | 3.11
• boto3 (AWS SDK for Python)

Installation

See the Installation Guidelines in the Documentation.

Development

Getting Started

Assuming you have Python 3.7+ 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_unit.py

Contribution Guidelines

The latest Contribution Guidelines with examples are in the documentation.

Release cycle

We follow both the Semantic Versioning pattern and PEP440 recommendations where they comply. The following are important notes about our release cycle:

• 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 closest staging branch (with smallest after release number of either current or next Minor).
• Make sure your branch is up to date with the branch you are making a PR to.

Example:

• Latest released version in PyPI 0.7.31
• Closest staging Minor branch in sosw/sosw 0_7_33
• Latest Minor staging branch in sosw/sosw 0_7_35
• Closest Next Minor branch in sosw/sosw 0_9_1

Your PR should be to either 0_7_33 or 0_9_1 depending on the importance of changes.

Code formatting

Follow PEP8, with the following specifications:

• both classes and functions are padded with 2 empty lines
• dictionaries are value-aligned

Initialization

1. Fork the repository: https://github.com/sosw/sosw
2. Register Account in AWS: SignUp
3. Run pipenv sync –dev to setup your virtual environment and download the required dependencies
4. 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.
5. Create Sandbox Lambda with Scheduler
6. Play with it.
7. Read the Documentation Convention.

More

See more guidelines for contribution in the docs.

Building the docs

Sphinx is used for building documentation.
You can build HTML documentation locally then use the built in Python web server to view the html version directly from localhost in your preferred browser.

$ sphinx-build -ab html ./docs ./sosw-rtd; (cd sosw-rtd && python -m http.server)

Copyright

This document has been placed in the public domain.

sosw - Serverless Orchestrator of Serverless Workers
The MIT License (MIT)
Copyright (C) 2024  sosw core contributors <info@sosw.app>:
    Nikolay Grishchenko
    Sophie Fogel
    Gil Halperin
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.