Metadata-Version: 2.1
Name: saladpy
Version: 1.0.2a5
Summary: A Python wrapper for the Salad Web API
Home-page: https://github.com/Coddo-Python/SaladPy
Author: Coddo-Python
Author-email: Coddo <coddobusiness@gmail.com>
License: The MIT License (MIT)
        
        Copyright (c) 2015-present Coddo-Python
        
        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.
Project-URL: Homepage, https://github.com/Coddo-Python/SaladPy
Keywords: salad,api,salad-web-api
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp (<4,>=3.7.4)

SaladPy
==========

Key Features
-------------

- Modern async API using `asyncio`.
- Allows you to access all the Salad web API endpoints
- Supports token caching

Installing
----------

To install the library, you can just run the following command:

```sh
# Linux/macOS
python3 -m pip install -U saladpy

# Windows
py -3 -m pip install -U saladpy
```

Quick Example
--------------

```py
import saladpy
import asyncio

async def main():
    client = saladpy.SaladClient()
    verify = await client.login("john.doe@example.com")

    # Verify using the OTP sent to your email
    await verify(input("Enter OTP: "))

    # Get Balance
    balance = await client.balance()
    print("Your Salad balance is", balance)

    # Safely close SaladClient (Highly Recommended)
    await client.close()

asyncio.run(main())
```

Docs
--------------
The docs are available at <https://saladpy.gitbook.io/saladpy-docs/>.

Contact
--------------
You can contact me at `Coddo#3210` on Discord! Ensure to first send me a friend request.
