https://github.com/lablup/callosum

An RPC Transport Library for asyncio
https://github.com/lablup/callosum

asyncio backendai networking python rpc zeromq

Last synced: about 1 month ago
JSON representation

An RPC Transport Library for asyncio

• Host: GitHub
• URL: https://github.com/lablup/callosum
• Owner: lablup
• License: mit
• Created: 2018-05-02T04:19:58.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-09-03T22:41:07.000Z (5 months ago)
• Last Synced: 2024-12-11T15:47:00.979Z (about 2 months ago)
• Topics: asyncio, backendai, networking, python, rpc, zeromq
• Language: Python
• Homepage:
• Size: 311 KB
• Stars: 19
• Watchers: 17
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Callosum

========

An RPC Transport Library

It provides an asynchronous multi-channel order-preserving message and data

streaming transport for *upper* RPC layers (e.g., Apache Thrift) by wrapping

*lower* transport implementations (e.g., ZeroMQ).

It aims to follow the latest coding style and conventions in Python asyncio.

*Corpus callosum* is a bundle of neuron fibers that connects two cerebral

hemispheres of a human brain.

Prerequisite

------------

Python 3.11 or higher.

Features

--------

* RPC

  - Native timeout and cancellation support

  - Explicit server-to-client error propagation including stringified tracebacks

  - Order preserving based on user-defined keys while keeping executions asynchronous

* Streaming

  - Broadcast & shared pipelines

* Optional client authentication and encrypted communication

  - Currently supported for only ZeroMQ with its CURVE library

* Optional message compression using [snappy](https://pypi.org/project/python-snappy/)

* Replacible and combinable lower/upper layers (ZeroMQ/Redis + JSON/msgpack/Thrift)

Planned features

----------------

* Managed streaming (with acks)

* Tunneling to bundle other channels and generic network traffic in a single connection

* Bidirectional RPC

* Chunked transfer of large messages

Installation

------------

To install the core:

```console

$ pip install -U pip setuptools

$ pip install callosum

```

You may add extra dependencies like:

```console

$ pip install 'callosum[zeromq,redis,thrift,snappy]'

```

Examples

--------

Please check out [the examples directory.](https://github.com/lablup/callosum/tree/master/examples)

Development

-----------

Create a virtual environment or an isolated Python environment using your favorite tool.

Inside it, run editable installation as follows:

```console

$ pip install -U pip setuptools

$ pip install -U -r requirements/dev.txt

```