# lendsmart_api
*python*
The official python library for the [Lendsmart API v1](https://lendsmartlabs.postman.co)` in python.
**This library is currently in beta.**
[](https://pypi.python.org/pypi/lendsmart-api)
[](https://pypi.python.org/pypi/lendsmart-api)
[https://badge.fury.io/py/lendsmart-api.svg](https://badge.fury.io/py/lendsmart-api)
## Pre reqs
- python 3
- install virtualenv using below command
```
pip install virtualenv
```
## Activate virtual environment
```
. ./venv/bin/activate
```
## Installation
```
pip install lendsmart_api
```
# Usage
You will need the service account private key files to access Lendsmart.
Only a limited set of API is supported.
## Client
### Create client
```
```
### Update Document
```
```
# Building from Source
To build and install this package:
- Clone this repository
```
cd core_api
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
```
# Local testing with lendsmart_api package
# Set environment path to your local file path in your python file
```
import sys
sys.path.append('/home/lendsmart/code/lendsmart/workspace/py_lscommon/core_api/')
```
# remove old package which is in virtual environment
```
rm -r /venv/lib/python3.8/site-packages/lendsmart_api
```
# 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_:
```
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.
[tox](http://tox.readthedocs.io)
# License
MIT
# Author
Lendsmart Inc, USA
Raw data
{
"_id": null,
"home_page": "https://bitbucket.org/lendsmartlabs/lendsmart_py/",
"name": "lendsmart-api",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "prediction ai lendsmart",
"author": "Smart Labs",
"author_email": "infos@lendsmart.ai",
"download_url": "https://files.pythonhosted.org/packages/a8/bc/6656be69399d01abb706b1667609595ccf1ad31372170ad8ecccdd74066d/lendsmart_api-2.12.tar.gz",
"platform": null,
"description": "# lendsmart_api\n\n*python*\n\nThe official python library for the [Lendsmart API v1](https://lendsmartlabs.postman.co)` in python.\n\n**This library is currently in beta.**\n\n[](https://pypi.python.org/pypi/lendsmart-api)\n[](https://pypi.python.org/pypi/lendsmart-api)\n\n[https://badge.fury.io/py/lendsmart-api.svg](https://badge.fury.io/py/lendsmart-api)\n\n\n\n## Pre reqs\n\n- python 3\n\n- install virtualenv using below command\n\n```\n pip install virtualenv\n```\n\n## Activate virtual environment\n\n```\n . ./venv/bin/activate\n```\n\n## Installation\n\n```\n pip install lendsmart_api\n```\n\n# Usage\n\nYou will need the service account private key files to access Lendsmart.\n\nOnly a limited set of API is supported.\n\n## Client\n\n### Create client\n\n```\n\n```\n\n### Update Document\n\n\n```\n\n\n```\n\n\n\n# Building from Source\n\n\nTo build and install this package:\n\n- Clone this repository\n\n```\n\n cd core_api\n\n virtualenv venv\n\n ./setup.py install\n```\n\n# Testing individually\n\nMake sure the `prereqs`, and `building from source` are complete\n\n```\n\n cd lendsmart_python\n\n . venv/bin/activate\n\n python3 get_documents_test.py\n```\n# Local testing with lendsmart_api package\n# Set environment path to your local file path in your python file\n\n```\nimport sys\nsys.path.append('/home/lendsmart/code/lendsmart/workspace/py_lscommon/core_api/')\n```\n# remove old package which is in virtual environment\n```\nrm -r /venv/lib/python3.8/site-packages/lendsmart_api\n```\n# Auto tests\n\nTests live in the ``tests`` directory. When invoking tests, make sure you are\nin the root directory of this project. To run the full suite across all\nsupported python versions, use tox_:\n\n```\n\n tox\n\n```\n\nRunning tox also runs pylint and coverage reports.\n\nThe test suite uses fixtures stored as JSON in `test/fixtures`. These files\ncontain sanitized JSON responses from the API - the file name is the URL called\nto produce the response, replacing any slashes with underscores.\n\nTest classes should extend `test.base.ClientBaseCase`. This provides them\nwith `self.client`, a `LendsmartClient` object that is set up to work with\ntests. Importantly, any GET request made by this object will be mocked to\nretrieve data from the test fixtures. This includes lazy-loaded objects using\nthis client (and by extension related models).\n\nWhen testing against requests other than GET requests, `self.mock_post` (and\nequivalent methods for other HTTP verbs) can be used in a ``with`` block to\nmock out the intended request type. \n\n[tox](http://tox.readthedocs.io)\n\n# License\n\nMIT\n\n# Author\n\nLendsmart Inc, USA\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The official python SDK for LendSmart API v1",
"version": "2.12",
"project_urls": {
"Homepage": "https://bitbucket.org/lendsmartlabs/lendsmart_py/"
},
"split_keywords": [
"prediction",
"ai",
"lendsmart"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "265c50467c2c75ecae6f10d53628a5b8ca96c9e78c4ba286f9d3ed1a368a146b",
"md5": "9769230a32e03dbf9b95aec5a1a99a39",
"sha256": "5792d64c87b01e6bcd634b92919c04f3eb418987ae726087f1ba4740c8fd7440"
},
"downloads": -1,
"filename": "lendsmart_api-2.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9769230a32e03dbf9b95aec5a1a99a39",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 47598,
"upload_time": "2023-11-23T12:50:55",
"upload_time_iso_8601": "2023-11-23T12:50:55.770183Z",
"url": "https://files.pythonhosted.org/packages/26/5c/50467c2c75ecae6f10d53628a5b8ca96c9e78c4ba286f9d3ed1a368a146b/lendsmart_api-2.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a8bc6656be69399d01abb706b1667609595ccf1ad31372170ad8ecccdd74066d",
"md5": "5d3ecc9323e13b7f58a7d8b4c7cb7265",
"sha256": "a51d35ffde4fca7bf286493dfc086a91d3ad85afc9f8ec8088faef4c6a06419b"
},
"downloads": -1,
"filename": "lendsmart_api-2.12.tar.gz",
"has_sig": false,
"md5_digest": "5d3ecc9323e13b7f58a7d8b4c7cb7265",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 36151,
"upload_time": "2023-11-23T12:50:57",
"upload_time_iso_8601": "2023-11-23T12:50:57.932467Z",
"url": "https://files.pythonhosted.org/packages/a8/bc/6656be69399d01abb706b1667609595ccf1ad31372170ad8ecccdd74066d/lendsmart_api-2.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-23 12:50:57",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "lendsmartlabs",
"bitbucket_project": "lendsmart_py",
"lcname": "lendsmart-api"
}
JSON