diff --git a/.gitignore b/.gitignore index 7bb7de2..74d45c4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ __pycache__ +dist .tox -.coverage \ No newline at end of file +.coverage +.vscode \ No newline at end of file diff --git a/README.md b/README.md index f036040..cd49caa 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,22 @@ 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: + +```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 @@ -73,4 +87,20 @@ response = client.get_other(page=7) ```python response = client.get_editorials(page=2, post_type="review", sort="title") -``` \ No newline at end of file +``` + +```python +response = client.get_about() +``` + +```python +response = client.get_socials() +``` + +```python +response = client.get_total_thread_pages(thread_id="5bbb986af1deda001d33bc4b") +``` + +```python +response = client.get_total_category_pages(category="games") +``` diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 081612f..9aa9c1f 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/loading_sdk.doctree b/docs/build/doctrees/loading_sdk.doctree index f2c0211..a4bf127 100644 Binary files a/docs/build/doctrees/loading_sdk.doctree and b/docs/build/doctrees/loading_sdk.doctree differ diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index a7ed714..79c70c5 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: 0c3450ade663ab19dc77abb5afee1b82 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_sources/loading_sdk.rst.txt b/docs/build/html/_sources/loading_sdk.rst.txt index 8dde1ee..301f258 100644 --- a/docs/build/html/_sources/loading_sdk.rst.txt +++ b/docs/build/html/_sources/loading_sdk.rst.txt @@ -7,7 +7,7 @@ Submodules loading\_sdk.api module ----------------------- -.. automodule:: loading_sdk.api +.. automodule:: loading_sdk.sync_api.client :members: :undoc-members: :show-inheritance: @@ -15,7 +15,7 @@ loading\_sdk.api module loading\_sdk.async_api module ----------------------------- -.. automodule:: loading_sdk.async_api +.. automodule:: loading_sdk.async_api.client :members: :undoc-members: :show-inheritance: diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js index 8c1afeb..beea1e3 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.4.1', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index 1159a82..a2e2603 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -3,7 +3,7 @@
-