Metadata-Version: 2.4
Name: tcp-sdk
Version: 1.0.29
Summary: Python SDK to query The Cross Product API.
Author-email: Eric Bazan <eric.bazan@thecrossproduct.com>, Kourosh Beroukhim <kourosh.beroukhim@thecrossproduct.com>, Theodore Chabardes <theodore.chabardes@thecrossproduct.com>, David Duque <david.duque@thecrossproduct.com>, Leonardo Gigli <leonardo.gigli@thecrossproduct.com>, Benjamin Grappe <benjamin.grappe@thecrossproduct.com>, Andres Serna <andres.serna@thecrossproduct.com>, Elise Vi Nhu Ba <elise.vinhuba@thecrossproduct.com>
License-File: LICENSE.txt
Requires-Python: >=3.11
Requires-Dist: ipython>=8.29.0
Requires-Dist: python-socketio>=5.11.4
Requires-Dist: requests-oauthlib>=2.0.0
Requires-Dist: requests>=2.32.3
Requires-Dist: slumber>=0.7.1
Requires-Dist: websocket-client>=1.8.0
Description-Content-Type: text/markdown


TCP python SDK 
==============

tcp-sdk is a Python module that provides a convenient object-oriented interface to TCP API. It acts as a wrapper around [slumber](https://github.com/samgiles/slumber).

QuickStart
----------

* Install *tcp-sdk*


      $ virtualenv my_virtualenv
      $ source my_virtualenv/bin/activate
      $ pip install tcp-sdk

* Connect to your TCP account

      import tcp
      client = tcp.client (usermail="user@domain.org", passwd="passwd")
      print(client.token)

  
Save this token to the environment variable `$TCP_API_TOKEN`.
Latter calls to ``tcp.client()`` will automatically connect to TCP API using this environment variable.

* Start using tcp-sdk

      import tcp
      client = tcp.client ()
      print (client.query().auth.get())

Requirements
------------

*tcp-sdk* requires the following modules.

 * *requests*
 * *slumber*
 * *requests-oauthlib*


