Skip to main content

The official python SDK for LendSmart API v1

Project description

lendsmart_api

.. highlight:: python

The official python library for the Lendsmart API v1_ in python.

This library is currently in beta.

.. image:: https://badge.fury.io/py/lendsmart-api.svg :target: https://badge.fury.io/py/lendsmart-api

Installation

::

pip install lendsmart_api

Pre reqs

  • python 3

  • install virtualenv using below command

::

pip install virtualenv

Building from Source

To build and install this package:

  • Clone this repository

::

cd lendsmart_python

virtualenv venv

./setup.py install

Testing individually

Make sure the prereqs, and building from source are complete

::

cd lendsmart_python

. venv/bin/activate

python3 get_documents_test.py

Auto tests

Tests live in the tests directory. When invoking tests, make sure you are in the root directory of this project. To run the full suite across all supported python versions, use tox_:

.. code-block:: shell

tox

Running tox also runs pylint and coverage reports.

The test suite uses fixtures stored as JSON in test/fixtures. These files contain sanitized JSON responses from the API - the file name is the URL called to produce the response, replacing any slashes with underscores.

Test classes should extend test.base.ClientBaseCase. This provides them with self.client, a LendsmartClient object that is set up to work with tests. Importantly, any GET request made by this object will be mocked to retrieve data from the test fixtures. This includes lazy-loaded objects using this client (and by extension related models).

When testing against requests other than GET requests, self.mock_post (and equivalent methods for other HTTP verbs) can be used in a with block to mock out the intended request type. These functions accept the relative path from the api base url that should be returned, for example::

.. _tox: http://tox.readthedocs.io

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for lendsmart-api, version 0.35.0
Filename, size File type Python version Upload date Hashes
Filename, size lendsmart_api-0.35.0-py2-none-any.whl (29.0 kB) File type Wheel Python version py2 Upload date Hashes View hashes
Filename, size lendsmart_api-0.35.0.tar.gz (21.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page