Skip to content

Latest commit

 

History

History
102 lines (63 loc) · 3.44 KB

README.rst

File metadata and controls

102 lines (63 loc) · 3.44 KB
https://travis-ci.org/angus-ai/angus-sdk-python.svg?branch=master

Angus Python SDK's documentation

Angus Python SDK is a python client library for Angus.ai perception web services. Please look at Angus.ai full API here.

Installation

Automatic installation:

pip install angus-sdk-python

Angus SDK is listed in PyPI and can be installed with pip or easy_install. Note that the source distribution includes demo applications that are not present when Angus SDK is installed in this way, so you may wish to download a copy of the source tarball as well.

Manual installation: Download here

tar xvfz angus-sdk-python-0.0.15.tar.gz
cd angus-sdk-python-0.0.15
python setup.py build
sudo python setup.py install

The Angus SDK source code is hosted on GitHub.

angus-sdk-python ships with a simple command tool 'angusme' that makes it easy to configure your environment.

You can explore all options by typing:

$ angusme --help

Configuration

In order to authenticate your request to Angus.ai servers, you must register here, and use the provided credentials as shown below. It is free and takes 1 minute.

In a terminal, type:

$ angusme
Please choose your gateway (current: https://gate.angus.ai): [Just press Enter]
Please copy/paste your client_id: ****-**-**-**-**********
Please copy/paste your access_token: ****-**-**-**-**********

Note that on Windows system, the previous command might not work. In that case use this command instead (replace by your Python installation path):

$ python C:\full\path\to\Python<version>\Scripts\angusme

Hello, world

Here is a simple "Hello, world" example for Angus SDK (replace macgyver.jpg by your own image with a face to detect):

import angus

conn = angus.connect()
service = conn.services.get_service('face_detection', version=1)
job = service.process({'image': open('./macgyver.jpg', 'rb')})
print(job.result['faces'])

Go further

  • The complete API documentation is available here.
  • See "Discussion and support" bellow.

Discussion and support

You can contact Angus.ai team at [email protected], and report bugs on the GitHub issue tracker.

For technical issues or question, start on Angus forum to get support by sending email on [email protected] or by using online web interface https://groups.google.com/a/angus.ai/d/forum/support

This web site and all documentation is licensed under Creative Commons 3.0.

Angus Python SDK is an Angus.ai open source technology. It is available under the Apache License, Version 2.0.. Please read LICENSE and NOTICE files for more information.

Copyright 2015-2017, Angus.ai