diff --git a/.gitignore b/.gitignore index 7bb7de2..539fb99 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ __pycache__ +dist .tox .coverage \ No newline at end of file diff --git a/README.md b/README.md index f036040..3f6a903 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,13 @@ [build-image]: https://github.com/hnrkcode/python-loading-sdk/actions/workflows/build.yaml/badge.svg [build-url]: https://github.com/hnrkcode/python-loading-sdk/actions/workflows/build.yaml -## How to install +## Install ``` pip install python-loading-sdk ``` -## Usage Examples +## Usage Instantiate the client and optionally provide login credentials to be able to use methods that requires the user to be logged in. @@ -25,8 +25,21 @@ Instantiate the client and optionally provide login credentials to be able to us from loading_sdk import LoadingApiClient client = LoadingApiClient(email="your@email.com", password="your_password") + +response = client.get_profile() +``` + +It can also be used asyncrounously usage: +```python +from loading_sdk import AsyncLoadingApiClient + +client = await AsyncLoadingApiClient(email="your@email.com", password="your_password") + +response = await client.get_profile() ``` +## Examples + ### Requires Auth ```python diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 081612f..c4cd996 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index a7ed714..2f95c55 100644 --- a/docs/build/html/.buildinfo +++ b/docs/build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 51fcf3155e9b8927d200a3927a4b8e0b +config: 2cdc8c0bb8e2a4831d8e8fe372441154 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js index 8c1afeb..dd1759d 100644 --- a/docs/build/html/_static/documentation_options.js +++ b/docs/build/html/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.2.0', + VERSION: '0.2.1', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index 1159a82..9aa78ac 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -3,7 +3,7 @@
-