LibLynx 0.17

Python Library to interact with LibLynx

LibLynx Python Library

Python Library to interact with LibLynx https://www.liblynx.com/

Usage example:

import liblynx

CLIENT_ID = "< your ID >"
CLIENT_SECRET = "< your SECRET >"
ll = liblynx.Connect(CLIENT_ID, CLIENT_SECRET)

# or just,
ll = liblynx.Connect()    # Then the ENV Variables LIBLYNX_CLIENT_ID and LIBLYNX_CLIENT_SECRET are used

print(ll.access_token)
print(ll.endpoint)
# Note how the .access_token and .endpoint attribute access results in a cached lookup

identification1 = ll.new_identification("127.0.0.127", "https://example.com/foo/", "Python-LibLynx-Testing/0.1")

ll.api("new account", c.endpoint["_links"]["@new_account"]["href"], "POST", {"account_name":"Some Account", "subscriptions":[{"title":"Foo", "start": "2020-11-01 10:56:58", "end": "2020-12-01 10:56:58"}]})

The environment variable LIBLYNX_BASE is checked for specifying a BASE URL, for example:

export LIBLYNX_BASE=https://connect.liblynx.com

if not found it uses: https://sandbox.liblynx.com

Middlewares

This library currently contains some integraitons with popular frameworks, Django and Starlette.

Django

To use the middleware, add it to the django.conf.MIDDLEWARE entry in the Django project settings file.

If a request can be identified, the attached LibLynx account name is stored in the session under the key LIBLYNX_ACCOUNT and the account id is stored in LIBLYNX_ACCOUNT_ID

It is optional (and normally highly desirable) to add the following settings;

LIBLYNX_FETCH_PRODUCTS : this will retrieve all the Content Units for the identified account, and add it to the request session under the LIBLYNX_PRODUCTS key.

Starlette

Documentation in progress, this middleware is subject to modification. It might be desirable to unify the session-based account retrieval in the same way as the Django middleware.