Skip to main content
PyCon US is happening May 14th-22nd in Pittsburgh, PA USA.  Learn more

Protocol implementation of the Asterisk Manager Interface and Asterisk Gateway Interface

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

Obelus is a MIT-licensed Python library providing support for communication with the Asterisk telephony server. It supports the Asterisk Manager Interface (AMI) and the Asterisk Gateway Interface (AGI).

Features

  • Python 2 and Python 3 support.

  • AMI, FastAGI and Async AGI support.

  • Event-driven API friendly towards non-blocking (“async”) network programming styles.

  • PEP 3156-style protocol implementations.

  • Framework-agnostic.

  • Adapters for the Tornado, Twisted, Tulip network programming frameworks.

  • Unit-tested.

Limitations

  • The API is currently low-level: it abstracts away protocol syntax and communication sequences, but doesn’t try to expose Asterisk concepts in a particular way.

Requirements

  • Python 2.7, 3.2 or later.

Optional requirements

Examples

AMI client

Several example AMI clients are available for different frameworks:

$ python -m obelus.ami.tornadoadapter -h
$ python -m obelus.ami.tulipadapter -h
$ python -m obelus.ami.twistedadapter -h

FastAGI server

Several example FastAGI servers are available for different frameworks:

$ python -m obelus.agi.tornadofastagi -h
$ python -m obelus.agi.tulipfastagi -h

Study the source codes for these modules for more information about how to re-use the Obelus protocol classes in your own application.

Development

Running the test suite

To run the test suite with a single Python version, run:

$ pythonX.Y -m obelus.test

On Python versions before 3.3, you will need to install the mock library.

To run the test suite on all supported interpreters, install tox and run:

$ tox

FAQ

Why “Obelus”?

An obelus is a typographical character, a bit like an asterisk.

Supported by

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