README

#Neokami PHP SDK v0.1

This SDK allows you to connect your PHP web-applications to the Neokami SDK.

In order to use the SDK, you need to obtain a free API Key from www.neokami.com.

#Installation

• via Composer:

   {
     "require" : {
       "neokami/php-sdk-v1" : "dev-master"
     }
   }
  

• via GitHub:

  1. clone the repository:

   git clone https://github.com/NeokamiCode/PHP-SDK.git
  

  1. inside your PHP project:

   require_once('/path/to/sdk/php-sdk/autoload.php');

#Usage

Here is a simple usage example for gender & age detection for images:

$req = new ImageAnalyser();
$req->setFile(__DIR__.'/data/team1.jpg');
$req->setApiKey('your api key here');
$req->setWait(0);
$analysis = $req->analyse();

Chained function calls are also supported for syntax brevity:

 $analysis = ImageAnalyser::Factory()->setApiKey("your api key")->setFile(__DIR__.'/data/team1.jpg')->analyse();

For in-depth details on how to use the SDK, check out:

Neokami Documentation

##Tests

• To run the tests, the composer package is required:

  Install composer globally, then run

   composer install

  to install the required files and dependencies.

• Create a NeokamiTestCredentials.php inside the tests/ folder based on the template in NeokamiTestCredentials.php.replace and enter your API Key.

  Repository contributors can apply for api keys to be used inside unit tests at team@neokami.com.

• The tests can be executed by running:

   ./vendor/bin/phpunit

##Contributing

Coming soon.