https://github.com/claws/gestalt
gestalt is a Python application framework for building distributed systems
https://github.com/claws/gestalt
asyncio python
Last synced: about 1 year ago
JSON representation
gestalt is a Python application framework for building distributed systems
- Host: GitHub
- URL: https://github.com/claws/gestalt
- Owner: claws
- License: mit
- Created: 2013-01-17T23:01:04.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2020-04-13T08:44:54.000Z (about 6 years ago)
- Last Synced: 2025-04-13T19:47:14.534Z (about 1 year ago)
- Topics: asyncio, python
- Language: Python
- Size: 198 KB
- Stars: 9
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- License: License
Awesome Lists containing this project
README
 [](https://pypi.python.org/pypi/gestalt) [](https://gestalt.readthedocs.io/en/latest)   
# Gestalt
Gestalt is an asyncio based Python package to help build distributed systems.
Gestalt provides a variety of building blocks to assist building long-running
network applications that leverage asyncio concurrency primitives.
```
gestalt:
an organized whole that is perceived as more than the sum of its parts.
```
> This project is in the early stages of development. Expects lots of changes.
## Features
The main features of Gestalt are:
- Inter-process Communications
- Automatic serialization and compression of message payloads.
- Socket endpoints.
- TCP
- Stream
- Netstring
- Message Type Identifier
- UDP
- Datagram
- Message Type Identifier
- Message queuing (i.e. AMQP) components. The Advanced Message
Queuing Protocol (AMQP) is an open standard protocol specification for
message passing, queuing, routing, reliability and security. One of the
most popular implementations of AMQP is RabbitMQ. The Gestalt package
provides high level components that support automatic message serialization
and compression of message payloads.
- Topic Publisher and Subscriber
- Request and Reply (RPC)
- A Timer component that simplifies creating periodic calls to a function.
Timers can be created as single-shot, repeat a specified number of times
or repeat forever.
- An application runner that simplifies running an asyncio application by
performing common setup such as creating an event loop, registering signal
handlers, registering a global exception handler and performing graceful
shutdown.
## Installation
Gestalt is available on PyPI and can be installed using [pip](https://pip.pypa.io).
Install core functionality using the command:
```console
$ pip install gestalt
```
Gestalt uses optional third party Python packages to obtain support for
features such as serialization, compression and message queuing. To install
optional extras simply specify one or more of them using the extras specifier
notation as shown in the example below which installs all of the available
extras:
```console
$ pip install gestalt[amq,protobuf,msgpack,avro,brotli,snappy,yaml]
```
where the available extras are:
- ``amq`` will install the AMQP extras (asyncio bindings for RabbitMQ)
- ``protobuf`` will install support for serializing Google Protocol Buffers structures.
- ``msgpack`` will install support for serializing Msgpack structures.
- ``yaml`` will install support for serializing YAML structures.
- ``avro`` will install support for serializing Apache Avro structures.
- ``brotli`` will install Brotli compression support.
- ``snappy`` will install Snappy compression support. The Python snappy package
is simply a binding to a system library. Therefore you must install that first
before the Python binding will install successfully. For example, on Debian
systems you will want ``sudo apt-get install libsnappy-dev``
Once installed you can begin using Gestalt to develop applications.
## Usage
There are many examples under the ``examples`` directory.
The [docs](http://gestalt.readthedocs.io) provides user and developer guides as
well as API-level documentation.
### Performance Tip
Consider using the high performance [uvloop](https://github.com/MagicStack/uvloop)
event loop implementation instead of the default asyncio event loop.
Install the package using:
```console
(venv) $ pip install uvloop
```
Then, simply call ``uvloop.install()`` before creating an asyncio event loop
either via the standard ``asyncio.get_event_loop()``, ``asyncio.run()`` or the
``gestalt.runner.run`` function.