Package: intellivoid
Intellivoid Services API Python WrapperThis is the official Python Library for Intellivoid Services API, this wrapper is
built based off the documentation fromhere.This library handles COA (Cross-Over Authentication), and the Intellivoid Services
features; in short: you can use this library to authenticate users, retrieve their
information and use the other features and services that are available on the
Intellivoid Services API. To have a greater understanding of how this is meant
to be used, please see the following documentation linksApplications IntroductionCOA IntroductionAccounts IntroductionSettings IntroductionInstallYou can either install it from PyPipipinstallintellivoidVia the Makefilemakeinstallor traditionally withsetup.pypython3setup.pyinstallNote on the implementationThe wrapper has been designed to be used both in a synchronous and in an asynchronous way:
the package is split across two main subpackages, namelyintellivoid.sync, for synchronous
behavior, andintellivoid.aio, for asynchronous behavior. The latter requires thetriolibrary to work, which is available on PyPi and listed as a project requirement (Trio's documentation).
The packages are identical in their structure and functionality, but note that exception
classes are shared and come from theintellivoid.syncpackage:intellivoid.aiohas no
dedicated exceptions modules and uses the synchronous' package exceptions instead.A quick exampleThis example is taken fromplaceholder_authenticate.pywhich demonstrates how you can easily authenticate a user and obtain their Access Token.fromintellivoid.sync.coaimportCrossOverAuthentication# Use your own Application ID and Secret Key. You'll be able to set your own# logo, name and permissions. These Application is for demonstration purposes only# and nobody can access your information using these Applications unless they have your Access Tokencoa=CrossOverAuthentication()application_id="APP65640a935039be5570428b6e74747811b0a290210e9e2d2f6722d8a54966ac171a4d5f1c"secret_key="51649e76483ff7de673e299a8056675409c957ec020998223ea02b3ccbaec1220747373d"print("Requesting authentication token")request_auth_results=coa.request_authentication(application_id=application_id,expand_ui=1)print("Authenticate:{}".format(request_auth_results["authentication_url"]))print("Waiting for authentication")process_authentication_results=coa.process_authentication(application_id=application_id,secret_key=secret_key,request_token=request_auth_results["request_token"],poll_results=True)# If poll_results is False, AwaitingAuthenticationError exception will be raised# If poll_results is True, the method will run in a loop until the user successfully authenticates# or if an error occurs such as the request token being expiredprint("Access Token:{0}".format(process_authentication_results["access_token"]))More examples can be foundherealong with README files that explains
what the example does, how it works and what it can be used for.CreditsThis library is developed by and copyrighted by Zi Xing Narrakas and/or Intellivoid and may only be used in compliance with the
included license, which you can find in this repo inside the LICENSE file.LicenseLicensed under GPLv3 or later versions, See the LICENSE for more information.