Skip to main content

Serverless Orchestrator of Serverless Workers

Project description

sosw - Serverless Orchestrator of Serverless Workers

Serverless Orchestrator of Serverless Workers

Build Status Documentation Status PyPI - Downloads PyPI - Licence

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


Documentation

https://docs.sosw.app

Essential Workflows

Essential sosw Workflow Schema

Dependencies

  • Python 3.10 | 3.11 | 3.12 | 3.13
  • 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) 2025  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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sosw-0.7.49.tar.gz (76.6 kB view details)

Uploaded Source

Built Distribution

sosw-0.7.49-py3-none-any.whl (97.2 kB view details)

Uploaded Python 3

File details

Details for the file sosw-0.7.49.tar.gz.

File metadata

  • Download URL: sosw-0.7.49.tar.gz
  • Upload date:
  • Size: 76.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sosw-0.7.49.tar.gz
Algorithm Hash digest
SHA256 5d60279bfab95942c30176c73be933591f6750b60afd79240b731b6c77afc7bc
MD5 519a131af0b7247f2f166fb6c17ba082
BLAKE2b-256 609f2b27065609bf8b9f094a6baa176f14675fc09040e593a9cebf3304339d55

See more details on using hashes here.

File details

Details for the file sosw-0.7.49-py3-none-any.whl.

File metadata

  • Download URL: sosw-0.7.49-py3-none-any.whl
  • Upload date:
  • Size: 97.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sosw-0.7.49-py3-none-any.whl
Algorithm Hash digest
SHA256 63e720ac05577c581875ef7b1cb35ecd91632765773a517e797e586d1f83a812
MD5 45c259111b7c4c008b07e9f23ce57834
BLAKE2b-256 e31588d50a42dcef6f570fb1aa1c8d8a5764d246d5ad4c5891ca0f84bbb13070

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page