LSOnSite

This package provides an OnSiteSession class—an extension of the Session class from Reqests—to connect to a Lightspeed OnSite Server and make requests.

OnSiteSession

The OnSiteSession keeps track of the hostname (with port) Private App ID and User Agent, as well as the username and password for the Lightspeed OnSite User your application will connect as.

The OnSiteSession automatically takes care of cookies (this is inherited from Requests' Session class), and will send a logout request when closing the Session.

Example

with lsonsite.OnSiteSession(HOST, PAPPID, USER_AGENT, USER, PW) as s:
    r = s.get('products/147')
    print(r.text)

XMLDict

This package also provides the XMLDict class. This takes a string of XML and converts it to a dictionary using xmltodict.

It will act like a Python dictionary, but print as indented XML:

with lsonsite.OnSiteSession(HOST, PAPPID, USER_AGENT, USER, PW) as s:
    r = s.get('products/147')
    print(r.xml)

Examples

Files with example code are included in example/. The examples use an xml config file, examples/config.xml to store information specific to your app.

<?xml version="1.0" encoding="utf-8"?>
<appconfig>
    <pappid>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</pappid>
    <user_agent>com.test.app/0.0</user_agent>
    <host>localhost:9630</host>
    <user>lightspeed</user>
    <password>admin</password>
</appconfig>

Dependencies

• Requests (2.11.0 or later)
• xmltodict (tested on 0.10.2)
• Pillow (Optional—only used by the included photo download example) (tested on 3.3.1)