Package: coronado
% coronado(5) Version 1.3.47 | Triple API Python wrapperNAMEcoronado- Native language wrapper for the Triple API.  The Triple API
enables partners to integrate with the Triple platform.  The full API
documentation is available fromhttps://api.tripleup.dev/docsPython API reference implementation:https://coronado-fi.github.io/coronadoJVM API:PENDINGTypescript/JavaScript API:https://coronado-fi.github.io/coronado-jsTriple API InfoService URL:https://api.partners.dev.tripleupdev.comService build: 0.0.0SYNOPSIS|coronado- Auth, TripleObjects, and business objects manipulation API
|triplchk- CLI for reporting if the Triple service is available and healthy
|triplwhoami- CLI tool for reporting client ID, content provider info for the current API user and scopetriplechktakes no arguments.  The Triple configuration file must exist in
the system-dependent configuration directory.triplewhoamitakes ascopeargument, wherescopeis one of:| CONTENT_PROVIDERS
| PORTFOLIOS
| PUBLISHERS
| VIEW_OFFERS
| NONEExecutables install to/usr/local/binunlesscoronadois installed in a
virtual environment, in which case they are installed to$VIRTUALENV/bin.DESCRIPTIONReference implementation wrapper for the Triple API.  All wrappers are
implemented under the umbrella project Coronado, can can be viewed on-line at:https://github.com/coronado-fihttps://coronado.fi- under constructionUse of this API requires credentials issued by tripleup.com and access to an S3
bucket provided by them.  Contact tripleup.com to assist you in setting up
access.InstallationThe coronado package is available in PyPI, Maven Central, NPM, CRAN, and other
indices and repositories.  Use the corresponding best-practice mechanism to
install.PythonpipinstallcoronadoThis makes the Triple API modules available in the current Python environment.
You may verify this with the command:piplist|awk'NR < 3 { print; next; } /coronado/'JVM - Kotlin, Java, Scala<dependency><groupId>io.github.coronado-fi</groupId><artifactId>coronado-jvm</artifactId><version>0.0.1-SNAPSHOT</version><type>pom</type></dependency>mvn buildTypescript/JavascriptnpminstallcoronadoAuthenticationThis component requires OAuth2 credentials available from Triple - please
contact a Triple representative to get this information.  Credentials cover:clientIDclientNamesecretserviceURL- different URLs for sandbox, staging, productiontokenURL- the OAuth2 service providerAuthentication tokens and service information are stored in thecoronado.auth.Authobjects.  API users need only create an instance of Auth
and use it across all services in the corresponding scope.  The Auth object
guarantees that a valid, current token is always available, regardless of the
OAuth2 expiration policy set.  If the token expires, Auth objects will request
a new token without user or programmer intervention.General use:auth=Auth(tokenURL,clientID='somevalue',clientSecret='53cr3+',scope=Scopes.PUBLISHERS)API wrappers usageThis example leverages the Publisher object and service, but the concepts shown
here apply to all the Coronado API business objects.  A better, more detailed
explanation is available viahttps://github.com/coronado-fi/coronado/quick-start-guide.ipynbor by running the same notebook in Lucyfer or Jupyter.# Once per run-time, per Coronado class:Publisher.initialize(serviceURL,auth)pubsList=Publisher.list()pubObject=Publisher.byID(42)assertpubsList[3].assumedName==pubObject.assumedNameprint(pubObject.address)All Coronado TripleObject classes and subclasses can be imported into pandas or
Kotlin DataFrame objects straight from the API, without further modifications:importpandasaspdpanel=pd.DataFrame([publisher.__dict__forpublisherinpubsList])panel.index=panel.objIDdel(panel['objID'])API referenceUnder constructionThe API references for all supporte languages are available from:https://coronado.fi/docsBUGSSee GitHub issues:https://github.com/coronado-fi/coronado/issuesFILESCoronado provides a simple configuration service via API that resolves a JSON
configuration file from system-specific, well-known file system locations.  All
paths are assumed to be under a service user in $HOME.Linux (XDG): `$HOME/.config/coronado/config.jsonmacOS: `$HOME/Application Support/coronado/config.jsonWindows:  TBDAll implementations use the paths resolved by the Python AppDirs object for
user configuration.AUTHORnumo LLC and Triple LLC, <coronado.project AT numo.com>SEE ALSOhttps://api.tripleup.dev/docshttps://github.com/coronado-fi/coronado/quick-start-guide.ipynb