Skip to main content

Async Python library for FreeSWITCH Event Socket Layer (ESL) - Build high-performance telephony applications with asyncio

Project description

Genesis

Build badge License badge Pypi Version badge Pypi python version badge Pypi wheel badge

Genesis is a Python library designed to build asynchronous applications that interact with FreeSWITCH through the Event Socket Layer (ESL).

Features

  • Asynchronous by Design: Built with asyncio for high-performance, non-blocking I/O.
  • Inbound, Outbound, and Consumer Modes: Supports all major ESL modes for comprehensive FreeSWITCH integration.
  • Decorator-Based Event Handling: A simple and intuitive way to handle FreeSWITCH events.
  • OpenTelemetry Support: Built-in instrumentation for tracing connections and commands.
  • Extensible and Customizable: Easily extend and customize the library to fit your needs.

Installation

Install Genesis using pip:

pip install genesis

For better asyncio performance on Unix (Linux and macOS), use the optional uvloop extra: pip install genesis[uvloop]. See the Installation Guide for details.

Quickstart

Inbound Socket Mode

import asyncio
from genesis import Inbound

async def uptime():
    async with Inbound("127.0.0.1", 8021, "ClueCon") as client:
        return await client.send("uptime")

async def main():
    response = await uptime()
    print(response)

asyncio.run(main())

Consumer Mode

import asyncio
from genesis import Consumer

app = Consumer("127.0.0.1", 8021, "ClueCon")

@app.handle("HEARTBEAT")
async def handler(event):
    await asyncio.sleep(0.001)
    print(event)

asyncio.run(app.start())

Outbound Socket Mode

import asyncio
from genesis import Outbound

async def handler(session):
    await session.answer()
    await session.playback('ivr/ivr-welcome')
    await session.hangup()

app = Outbound(handler, "127.0.0.1", 5000)

asyncio.run(app.start())

Documentation

Full documentation is available on the documentation website.

To preview the docs locally, install Hugo and run:

hugo server --source docs --disableFastRender

Running Tests

Install development dependencies with Poetry and execute the test suite using tox:

poetry install
tox

How to Contribute

Contributions are welcome! Whether it's improving documentation, suggesting new features, or fixing bugs, your help is appreciated.

Please read our Contributing Guide and Code of Conduct to get started.

Contributors

Vitor
Vitor Hugo
RL/
RL
Dongwoon
Dongwoon Kim

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

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

genesis-2026.6.17.tar.gz (44.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

genesis-2026.6.17-py3-none-any.whl (59.8 kB view details)

Uploaded Python 3

File details

Details for the file genesis-2026.6.17.tar.gz.

File metadata

  • Download URL: genesis-2026.6.17.tar.gz
  • Upload date:
  • Size: 44.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.10.2 Linux/6.17.0-1018-azure

File hashes

Hashes for genesis-2026.6.17.tar.gz
Algorithm Hash digest
SHA256 ec1d9d5ea0d2efac157d39ea59481434224a12060b3cffeac4e3079fcbf97093
MD5 3260cc69bc239dfae3540bf9507315dd
BLAKE2b-256 ea556c5fa28e872ee7701ddf0703170974782883985c0438b3a6b77652a65398

See more details on using hashes here.

File details

Details for the file genesis-2026.6.17-py3-none-any.whl.

File metadata

  • Download URL: genesis-2026.6.17-py3-none-any.whl
  • Upload date:
  • Size: 59.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.10.2 Linux/6.17.0-1018-azure

File hashes

Hashes for genesis-2026.6.17-py3-none-any.whl
Algorithm Hash digest
SHA256 5b3ccfeb50223fe986f976539d13ea82704a8f2992b067bce6129868a71ca4f4
MD5 804ef0fe8e6cb701db8a6ef3042ca780
BLAKE2b-256 4cc4f227ccde21168bb8562e869b91db7c6e1b29248884375186a0c2621877ad

See more details on using hashes here.

Supported by

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