A Python package for interacting with the Identix.one API
Project description
identixone-python
=================
.. image:: https://img.shields.io/pypi/v/identixone.svg
:target: https://pypi.python.org/pypi/identixone
.. image:: https://secure.travis-ci.org/identixone/identixone-python.png?branch=master
:target: https://travis-ci.org/identixone/identixone-python
.. image:: https://readthedocs.org/projects/identixone-python/badge/?version=latest
:target: https://identixone-python.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://pyup.io/repos/github/identixone/identixone-python/shield.svg
:target: https://pyup.io/repos/github/identixone/identixone-python/
:alt: Updates
A Python package for interacting with the Identix.one API
* Free software: MIT license
* Documentation: https://identixone-python.readthedocs.io/
Installation
------------
Install from PyPi using
`pip <http://www.pip-installer.org/en/latest/>`__, a package manager for
Python.
::
pip install identixone
Don't have pip installed? Try installing it, by running this from the
command line:
::
$ curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python
Or, you can `download the source code
(ZIP) <https://github.com/identixone/identixone-python/zipball/master>`__ for
``identixone-python``, and then run:
::
python setup.py install
You may need to run the above commands with ``sudo``.
API Credentials
~~~~~~~~~~~~~~~
Get your free API token for development at https://identix.one
Getting Started
---------------
First of all, specify your API token and API version in `Client`:
.. code:: python
from identixone.api import Client
version = 1
token = 'XXX'
client = Client(token, version)
Now just make calls using `client` instance as if you were interacting with HTTP API.
For example, create source:
.. code:: python
response = client.sources.create(name='source_name')
# response = {"id": 1, "name": "source_name", "pps_timestamp": False, ... }
Or list some records with filters:
.. code:: python
import datetime
period_start = datetime.datetime(
year=2019, month=1, day=13, hour=19, minute=20, second=1)
period_end = period_start + datetime.timedelta(days=1)
response = client.records.list(
new=True, nm=False, junk=False, exact=False,
ha=False, det=False, period_start=period_start,
period_end=period_end)
# response = {"result": "ok", "totalqty": 0, "records": [], "sources": []}
Or even compare two faces how similar they are:
.. code:: python
from identixone.base.choices import Conf
response = client.utility.compare(
photo1, photo2,
liveness_photo1=False, liveness_photo2=False,
conf=Conf.JUNK)
# response = {"similar": True, "conf": "ha", "liveness_photo1": False, "liveness_photo2": True}
Full examples are inside `examples.py` file in the root of this repo.
To explore all of the API endpoints visit https://kb.identix.one/
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
0.1.0 (2019-02-18)
------------------
* First release on PyPI.
=================
.. image:: https://img.shields.io/pypi/v/identixone.svg
:target: https://pypi.python.org/pypi/identixone
.. image:: https://secure.travis-ci.org/identixone/identixone-python.png?branch=master
:target: https://travis-ci.org/identixone/identixone-python
.. image:: https://readthedocs.org/projects/identixone-python/badge/?version=latest
:target: https://identixone-python.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://pyup.io/repos/github/identixone/identixone-python/shield.svg
:target: https://pyup.io/repos/github/identixone/identixone-python/
:alt: Updates
A Python package for interacting with the Identix.one API
* Free software: MIT license
* Documentation: https://identixone-python.readthedocs.io/
Installation
------------
Install from PyPi using
`pip <http://www.pip-installer.org/en/latest/>`__, a package manager for
Python.
::
pip install identixone
Don't have pip installed? Try installing it, by running this from the
command line:
::
$ curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python
Or, you can `download the source code
(ZIP) <https://github.com/identixone/identixone-python/zipball/master>`__ for
``identixone-python``, and then run:
::
python setup.py install
You may need to run the above commands with ``sudo``.
API Credentials
~~~~~~~~~~~~~~~
Get your free API token for development at https://identix.one
Getting Started
---------------
First of all, specify your API token and API version in `Client`:
.. code:: python
from identixone.api import Client
version = 1
token = 'XXX'
client = Client(token, version)
Now just make calls using `client` instance as if you were interacting with HTTP API.
For example, create source:
.. code:: python
response = client.sources.create(name='source_name')
# response = {"id": 1, "name": "source_name", "pps_timestamp": False, ... }
Or list some records with filters:
.. code:: python
import datetime
period_start = datetime.datetime(
year=2019, month=1, day=13, hour=19, minute=20, second=1)
period_end = period_start + datetime.timedelta(days=1)
response = client.records.list(
new=True, nm=False, junk=False, exact=False,
ha=False, det=False, period_start=period_start,
period_end=period_end)
# response = {"result": "ok", "totalqty": 0, "records": [], "sources": []}
Or even compare two faces how similar they are:
.. code:: python
from identixone.base.choices import Conf
response = client.utility.compare(
photo1, photo2,
liveness_photo1=False, liveness_photo2=False,
conf=Conf.JUNK)
# response = {"similar": True, "conf": "ha", "liveness_photo1": False, "liveness_photo2": True}
Full examples are inside `examples.py` file in the root of this repo.
To explore all of the API endpoints visit https://kb.identix.one/
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
0.1.0 (2019-02-18)
------------------
* First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
identixone-0.1.0.tar.gz
(24.6 kB
view hashes)
Built Distribution
Close
Hashes for identixone-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01224e50f2f71e56ebccca79cc95a873778656d1d27441eb5d38ea9d0845f793 |
|
MD5 | cd1c77b7d15da1164f5beed7ab020e76 |
|
BLAKE2b-256 | c3f6c3735104488992a939d7752b484914ea5d410b76a3f5cc8b3ea729ab47ce |