#Neokami Python SDK v0.2
This SDK allows you to connect your Python 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 pip:
pip install neokami-sdk
Inside your python project
import neokami
#Usage
Here is a simple usage example for gender & age detection for images:
import os
import neokami
req = neokami.ImageAnalyser()
directory = os.path.dirname(os.path.abspath(__file__))
req.setFile(directory + '/data/team1.jpg')
req.setType('gender')
req.setApiKey('your api key here')
req.setWait(1)
analysis = req.analyse()
#get the results
results = analysis.result()
Chained function calls are also supported for syntax brevity:
import os
import neokami
directory = os.path.dirname(os.path.abspath(__file__))
analysis = neokami.ImageAnalyser().setApiKey(NeokamiTestCredentials.api_key).setFile(directory +'/data/team1.jpg').setType('gender').analyse()
For in-depth details on how to use the SDK, check out:
##Tests
-
To run the tests, the pytest package is required:
pip install -U pytest # or easy_install -U pytest
-
Create a NeokamiTestCredentials.python inside the tests/ folder based on the template in NeokamiTestCredentials.python.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:
py.test
##Contributing
Coming soon.
#Release History ##0.2
- Send API key on the header.
- Add Visual Cortex.
- Add Sentiment Analysis.
##0.1.1
- HTTPS connection for the base url.
##0.1
- Birth.