<commit_before>AsterBunny
==========

Simple PHP based CLI tool to publish Asterisk AMI events to a Rabbit Message Queue

PHP Versions
------------

Note: PAMI Requires PHP 5.3+. PHP versions 5.3.9 and 5.3.10 WILL NOT WORK due
to a bug introduced in stream_get_line() in 5.3.9. Please use 5.3.11+ or up
to 5.3.8 (see README.PHP-5.3.9-and-5.3.10).


Install
=======

Clone the repo:

```bash
git clone https://github.com/opensoft/AsterBunny.git
```

Now install dependencies with composer

```bash
curl http://getcomposer.org/installer | php
php composer.phar install
```

Usage
=====

The CLI tool is located at `bin/asterbunny` and has a lot of configuration options relating to specifying hostnames, ports,
usernames, and passwords for Asterisk connections and RabbitMQ servers.

It's recommended to run the following to learn the configuration set, and defaults

```bash
./bin/asterbunny listen --help<commit_msg>Add link to specific readme doc for pami<commit_after>AsterBunny
==========

Simple PHP based CLI tool to publish Asterisk AMI events to a Rabbit Message Queue

PHP Versions
------------

Note: PAMI Requires PHP 5.3+. PHP versions 5.3.9 and 5.3.10 WILL NOT WORK due
to a bug introduced in stream_get_line() in 5.3.9. Please use 5.3.11+ or up
to 5.3.8 (see [README.PHP-5.3.9-and-5.3.10](https://github.com/marcelog/PAMI/blob/1.70.0/README.PHP-5.3.9-and-5.3.10)).


Install
=======

Clone the repo:

```bash
git clone https://github.com/opensoft/AsterBunny.git
```

Now install dependencies with composer

```bash
curl http://getcomposer.org/installer | php
php composer.phar install
```

Usage
=====

The CLI tool is located at `bin/asterbunny` and has a lot of configuration options relating to specifying hostnames, ports,
usernames, and passwords for Asterisk connections and RabbitMQ servers.

It's recommended to run the following to learn the configuration set, and defaults

```bash
./bin/asterbunny listen --help
{'fraction_non_alphanumeric': 0.12558139534883722, 'fraction_numerical': 0.03255813953488372, 'mean_word_length': 3.864321608040201, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '35972', 'n_tokens_mistral': 696, 'n_tokens_neox': 613, 'n_words': 236}