Skip to content

Commit

Permalink
prepare for 0.2 release
Browse files Browse the repository at this point in the history
  • Loading branch information
mattieb committed Jan 8, 2014
1 parent f484875 commit 8827aff
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 11 deletions.
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@
`octothorpe` is an [Asterisk Manager Interface][2] (AMI) library
for the [Twisted][1] engine.

At the moment, `octothorpe` is still in early development, though
I intend it to eventually offer full asynchronous AGI functionality.
Because of this, I cannot at this time offer API stability, but
I intend to do this as it shapes up further.
In this release, it now offers asynchronous AGI functionality—see
the `*hello` examples in `doc/examples`.

At the moment, `octothorpe` is still in development. Because of
this, I cannot at this time offer API stability, but I intend to
do this as it shapes up further.

`octothorpe`'s primary design goal is to disentangle the myriad
multiplexed event streams that all come over the AMI, making it
Expand All @@ -17,16 +19,21 @@ object you will thereafter receive channel-associated events on as
well as be able to issue actions against. (Of course, you can
subclass `Channel`.)

`octothorpe` is fully developed with a test-first methodology. All
functionality is covered by the unit tests, which we verify with
[`coverage.py`][4] (see `COVERAGE.md`).

Requirements
------------

`octothorpe` depends only on Twisted, and is developed against the
latest release version (currently 13.2.0). The unit tests (which
you can run with `trial octothorpe`) additionally require [Mock][3].
latest release version (currently 13.2.0).

Development
-----------

`octothorpe` is fully developed with a test-first methodology. All
functionality is covered by the unit tests, which can be verified
with [`coverage.py`][4] (see `COVERAGE.md`).

The unit tests (which you can run with `trial octothorpe`) additionally
require [Mock][3].

[1]: http://twistedmatrix.com/
[2]: https://wiki.asterisk.org/wiki/display/AST/The+Asterisk+Manager+TCP+IP+API
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setup(
name='octothorpe',
version='0.1.99',
version='0.2',
description='Asterisk Manager Interface library for the Twisted engine',
author='Matt Behrens',
author_email='matt@zigg.com',
Expand Down

0 comments on commit 8827aff

Please sign in to comment.