Skip to main content

A Python library for writing (micro)services and their clients

Project description

https://readthedocs.org/projects/pysoa/badge/ https://pepy.tech/badge/pysoa https://img.shields.io/pypi/l/pysoa.svg https://api.travis-ci.org/eventbrite/pysoa.svg https://img.shields.io/pypi/v/pysoa.svg https://img.shields.io/pypi/wheel/pysoa.svg https://img.shields.io/pypi/pyversions/pysoa.svg

PySOA is a general-purpose library for writing fast Python (micro)services and their clients, based on an RPC (remote procedure call) calling style. It provides both a client and a server, which can be used directly by themselves or, as we do, extended with extra functionality (our authentication, database routing, and other code is written as private middleware and runs on top of this library).

PySOA uses the concept of pluggable “transports” to define a layer for sending requests and responses (messages) between clients and servers. The default, production-ready included transport is a Redis pub-sub layer, which we use in combination with Redis Sentinel in clusters. A single Redis cluster is capable of handling tens of thousands of PySOA messages per second with extremely efficient and desirable load-balancing properties. There is also a local transport implementation primarily used for testing and demonstration but capable of being used in production where appropriate.

Basic Tenets

  • Services and actions both have simple names, and are called from the client by name. You can call actions individually, or bundle multiple action calls into a “job” to be run serially (either aborting or continuing on error).

  • Requests and responses are simply Python dictionaries, and PySOA uses our open source validation framework Conformity in order to verify their schema on the way in and out.

  • Message bodies are encoded using MessagePack by default (however, you can define your own serializer), with a few non-standard types encoded using MessagePack extensions, such as dates, times, date-times, and amounts of currency (using our open source currint library).

  • Requests have a context, which is sourced from the original client context (web request, API request, etc.) and automatically chained down into subsequent client calls made inside the service. This is used for contextual request information like correlation IDs, authentication tokens, locales, etc.

  • We include “SOA Switches” as a first-party implementation of feature flags/toggles. Part of the context, they are bundled along with every request and automatically chained, and are packed as integers to ensure they have minimal overhead.

This intro summarizes some of the key concepts of using PySOA. For more thorough documentation, see the PySOA Documentation.

License

PySOA is licensed under the Apache License, version 2.0.

Installation

PySOA is available in PyPi and can be installing directly via Pip or listed in setup.py, requirements.txt, or Pipfile:

pip install 'pysoa~=1.2'
install_requires=[
    ...
    'pysoa~=1.2',
    ...
]
pysoa~=1.2
pysoa = {version="~=1.2"}

Documentation

The complete PySOA documentation is available on Read the Docs!

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

pysoa-1.4.8.tar.gz (157.6 kB view details)

Uploaded Source

Built Distribution

pysoa-1.4.8-py27.py35.py36.py37.py38-none-any.whl (194.7 kB view details)

Uploaded Python 2.7 Python 3.5 Python 3.6 Python 3.7 Python 3.8

File details

Details for the file pysoa-1.4.8.tar.gz.

File metadata

  • Download URL: pysoa-1.4.8.tar.gz
  • Upload date:
  • Size: 157.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.1

File hashes

Hashes for pysoa-1.4.8.tar.gz
Algorithm Hash digest
SHA256 15463c027fc8b8827801714e3476f5586956a7f66a2d491236f2448dab444680
MD5 37dddd0f798977642860e49a5172e2b4
BLAKE2b-256 541675ef088feadc29316cbf83bb18ee3e2ecf812eb9b900167a6568191e4b04

See more details on using hashes here.

File details

Details for the file pysoa-1.4.8-py27.py35.py36.py37.py38-none-any.whl.

File metadata

File hashes

Hashes for pysoa-1.4.8-py27.py35.py36.py37.py38-none-any.whl
Algorithm Hash digest
SHA256 7f774cea72a373ec9e449ef051734ffccd11a3b0fcccbe1273df1037517e2c7d
MD5 3e1e3add2fb1f12c460f4b470ccd83a0
BLAKE2b-256 3dfdf2c7676bcee23e06ae653a075d5921ac20173c3d5caf0a5cc9d96db38364

See more details on using hashes here.

Supported by

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