<commit_before># PHP Client for Abenity API

A PHP library for using the Abenity API.  

You can find the full API documentation in the [official documentation](http://api.abenity.com/documentation).

## Requirements

This library requires PHP 5.3+

## Installation

### With Composer

[`abenity/abenity-php`](http://packagist.org/packages/abenity/abenity-php) package is available on [Packagist](http://packagist.org).

Install Composer if necessary
```
curl -sS https://getcomposer.org/installer | php
```
Include it in your `composer.json` as follows:

1. Add abenity/abenity-php as a dependency in composer.json.

    ```
    "require": {
        ...
        "abenity/abenity-php" : "0.*"
        ...
    }
    ```

    Or  from the command line.

    ```
    php composer.phar require abenity/abenity-php:0.*
    ```

2. Run `composer update`.
3. Now `Abenity` will be autoloaded into your project.

    ```
    require 'vendor/autoload.php';

    $abenity = new Abenity\ApiClient('my_api_key','my_api_username','my_api_password');
    ```

### Manually
1. Download the latest release.
2. Extract into a folder in your project root named "abenity-php".
2. Include `Abenity` in your project like this:

    ```
    require 'abenity-php/lib/Abenity.php';

    $abenity = new Abenity\ApiClient('my_api_key','my_api_username','my_api_password');
    ```

## Usage

### See examples folder


## Contributing
Run the tests from the project root with [PHPUnit](http://phpunit.de) like this:

```
phpunit --bootstrap vendor/autoload.php test/AbenityTest
```
<commit_msg>Updated readme to mention mcrypt requirement<commit_after># PHP Client for Abenity API

A PHP library for using the Abenity API.  

You can find the full API documentation in the [official documentation](http://api.abenity.com/documentation).

## Requirements

This library requires PHP 5.3+ with the [mcrypt module](http://php.net/manual/en/book.mcrypt.php)

## Installation

### With Composer

[`abenity/abenity-php`](http://packagist.org/packages/abenity/abenity-php) package is available on [Packagist](http://packagist.org).

Install Composer if necessary
```
curl -sS https://getcomposer.org/installer | php
```
Include it in your `composer.json` as follows:

1. Add abenity/abenity-php as a dependency in composer.json.

    ```
    "require": {
        ...
        "abenity/abenity-php" : "0.*"
        ...
    }
    ```

    Or  from the command line.

    ```
    php composer.phar require abenity/abenity-php:0.*
    ```

2. Run `composer update`.
3. Now `Abenity` will be autoloaded into your project.

    ```
    require 'vendor/autoload.php';

    $abenity = new Abenity\ApiClient('my_api_key','my_api_username','my_api_password');
    ```

### Manually
1. Download the latest release.
2. Extract into a folder in your project root named "abenity-php".
2. Include `Abenity` in your project like this:

    ```
    require 'abenity-php/lib/Abenity.php';

    $abenity = new Abenity\ApiClient('my_api_key','my_api_username','my_api_password');
    ```

## Usage

### See examples folder


## Contributing
Run the tests from the project root with [PHPUnit](http://phpunit.de) like this:

```
phpunit --bootstrap vendor/autoload.php test/AbenityTest
```

{'fraction_non_alphanumeric': 0.13521039603960397, 'fraction_numerical': 0.006188118811881188, 'mean_word_length': 3.4287671232876713, 'pattern_counts': {'":': 2, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3761911', 'n_tokens_mistral': 1090, 'n_tokens_neox': 1071, 'n_words': 295}