| Name | saladpy JSON |
| Version |
1.0.2a5
JSON |
| download |
| home_page | https://github.com/Coddo-Python/SaladPy |
| Summary | A Python wrapper for the Salad Web API |
| upload_time | 2023-07-13 09:45:43 |
| maintainer | |
| docs_url | None |
| author | Coddo-Python |
| requires_python | >=3.8.0 |
| 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. |
| keywords |
salad
api
salad-web-api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/Coddo-Python/SaladPy",
"name": "saladpy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.0",
"maintainer_email": "",
"keywords": "salad,api,salad-web-api",
"author": "Coddo-Python",
"author_email": "Coddo <coddobusiness@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/03/bb/2c691bd278e10b3b47693ca10c3bde790bc86dec75cfee0936160af84203/saladpy-1.0.2a5.tar.gz",
"platform": null,
"description": "SaladPy\n==========\n\nKey Features\n-------------\n\n- Modern async API using `asyncio`.\n- Allows you to access all the Salad web API endpoints\n- Supports token caching\n\nInstalling\n----------\n\nTo install the library, you can just run the following command:\n\n```sh\n# Linux/macOS\npython3 -m pip install -U saladpy\n\n# Windows\npy -3 -m pip install -U saladpy\n```\n\nQuick Example\n--------------\n\n```py\nimport saladpy\nimport asyncio\n\nasync def main():\n client = saladpy.SaladClient()\n verify = await client.login(\"john.doe@example.com\")\n\n # Verify using the OTP sent to your email\n await verify(input(\"Enter OTP: \"))\n\n # Get Balance\n balance = await client.balance()\n print(\"Your Salad balance is\", balance)\n\n # Safely close SaladClient (Highly Recommended)\n await client.close()\n\nasyncio.run(main())\n```\n\nDocs\n--------------\nThe docs are available at <https://saladpy.gitbook.io/saladpy-docs/>.\n\nContact\n--------------\nYou can contact me at `Coddo#3210` on Discord! Ensure to first send me a friend request.\n",
"bugtrack_url": null,
"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.",
"summary": "A Python wrapper for the Salad Web API",
"version": "1.0.2a5",
"project_urls": {
"Homepage": "https://github.com/Coddo-Python/SaladPy"
},
"split_keywords": [
"salad",
"api",
"salad-web-api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5ec5ab5515d4e8e9eab533d6bea655de2d8cbe9f0a1349b1a93d043a34e20946",
"md5": "718f18acadf7eb9a355760ac3d53ba9b",
"sha256": "0264e0be3c131b6a632e939b162e5c87b7262544142dacca96409f1a14b266b7"
},
"downloads": -1,
"filename": "saladpy-1.0.2a5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "718f18acadf7eb9a355760ac3d53ba9b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.0",
"size": 8261,
"upload_time": "2023-07-13T09:45:41",
"upload_time_iso_8601": "2023-07-13T09:45:41.855068Z",
"url": "https://files.pythonhosted.org/packages/5e/c5/ab5515d4e8e9eab533d6bea655de2d8cbe9f0a1349b1a93d043a34e20946/saladpy-1.0.2a5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "03bb2c691bd278e10b3b47693ca10c3bde790bc86dec75cfee0936160af84203",
"md5": "0038d00db4577abff2f5a3c3783ea80f",
"sha256": "1b25df602a687799411a468266a65a7237a7ad66040bfcc21d432531ab56c4de"
},
"downloads": -1,
"filename": "saladpy-1.0.2a5.tar.gz",
"has_sig": false,
"md5_digest": "0038d00db4577abff2f5a3c3783ea80f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.0",
"size": 7948,
"upload_time": "2023-07-13T09:45:43",
"upload_time_iso_8601": "2023-07-13T09:45:43.109511Z",
"url": "https://files.pythonhosted.org/packages/03/bb/2c691bd278e10b3b47693ca10c3bde790bc86dec75cfee0936160af84203/saladpy-1.0.2a5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-13 09:45:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Coddo-Python",
"github_project": "SaladPy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "saladpy"
}
