lendingclub2 0.4.0

Help automating LendingClub processes

Copyright (c) 2017 Alex Hartoto

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Description: .. image:: https://travis-ci.org/ahartoto/lendingclub2.svg?branch=master
:target: https://travis-ci.org/ahartoto/lendingclub2

.. image:: https://readthedocs.org/projects/lendingclub2/badge/?version=latest
:target: http://lendingclub2.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/lendingclub2.svg
:target: https://pypi.python.org/pypi/lendingclub2

.. image:: https://img.shields.io/pypi/pyversions/lendingclub2.svg
:target: https://pypi.python.org/pypi/lendingclub2

################
Lending Club API
################

Welcome to the unofficial Lending Club Python API. This library is inspired by
the `LendingClub <https://github.com/jgillick/LendingClub>`_ library, but
utilizes the REST API endpoints and applies the `best practices
<https://www.lendingclub.com/developers/best-practices.action>`_ from Lending
Club. For more complete information about Lending Club's REST API, please go
to `this page <https://www.lendingclub.com/developers/lc-api.action>`_.

************
Requirements
************

This library expects that the user has pre-generated the Authentication key.
If you are unfamiliar with it, please go to Lending Club `documentation page
<https://www.lendingclub.com/developers/authentication.action>`_ to find
the instructions on how to generate one.

The authentication key can be passed to the application as an environment
variable (``$LENDING_CLUB_API_KEY``) or using the configuration file.

User is also expected to know their investor ID number. Please login to your
Lending Club account to find your investor ID number. The investor ID number
can be passed to the application as an environment variable
(``$LENDING_CLUB_INVESTOR_ID``) or using the configuration file.

******************
Configuration File
******************

If user chooses to specify either the authentication key or investor ID number
using the configuration file, the configuration file has to include the
following information:

.. code-block:: cfg

[access]
api_key = THIS_IS_EXAMPLE_API_KEY=

[account]
investor_id = 123456789

The location of the configuration file by default is ``$HOME/.lendingclub``,
but user can override it by specifying the custom path using
``$LENDING_CLUB_CONFIG`` environment variable.

********
Examples
********

.. code-block:: python

from lendingclub2.account import InvestorAccount

# Find information about account's available balance
account = InvestorAccount()
print(account.available_balance)

Keywords: lendingclub,lending-club,p2p,loan,api
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Office/Business :: Financial