<h1 align="center">Spankbang API</h1>
<div align="center">
<a href="https://pepy.tech/project/spankbang_api"><img src="https://static.pepy.tech/badge/spankbang_api" alt="Downloads"></a>
<a href="https://github.com/EchterAlsFake/spankbang_api/workflows/"><img src="https://github.com/EchterAlsFake/spankbang_api/workflows/CodeQL/badge.svg" alt="CodeQL Analysis"/></a>
<a href="https://github.com/EchterAlsFake/spankbang_api/workflows/"><img src="https://github.com/EchterAlsFake/spankbang_api/actions/workflows/tests.yml/badge.svg" alt="API Tests"/></a>
</div>
# Description
Spankbang API is an API for Spankbang. It allows you to fetch information from videos using regexes and requests.
# Disclaimer
> [!IMPORTANT]
> Spankbang API is in violation to Spankbang's ToS!
> If you are the website owner of spankbang.com, contact me at my E-Mail, and I'll take this repository immediately offline.
> EchterAlsFake@proton.me
> [!NOTE]
> This API was made for my other project Porn Fetch, which is the reason why I keep it so minimal. If you have any features you need, please
> just open an Issue and I will add that feature to this API. I will also add other features, later but my priority is primarily downloading videos!
# Quickstart
### Have a look at the [Documentation](https://github.com/EchterAlsFake/API_Docs/blob/master/Porn_APIs/Spankbang.md) for more details
- Install the library with `pip install spankbang_api`
- Or from git using `pip install git+https://github.com/EchterAlsFake/spankbang_api`
```python
from spankbang_api import Client, Quality
# Initialize a Client object
client = Client()
# Fetch a video
video_object = client.get_video("<insert_url_here>")
# Get information from videos
video_object.title
video_object.rating
video_object.description
# See docs for more...
# Download the video
video_object.download(quality=Quality.BEST, path="your_output_path")
```
# Changelog
See [Changelog](https://github.com/EchterAlsFake/spankbang_api/blob/master/README/Changelog.md) for more details.
# Contribution
Do you see any issues or having some feature requests? Simply open an Issue or talk
in the discussions.
Pull requests are welcome :)
# License
Licensed under the LGPLv3 License
Copyright (C) 2023–2024 Johannes Habel
Raw data
{
"_id": null,
"home_page": "https://github.com/EchterAlsFake/spankbang_api",
"name": "spankbang-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Johannes Habel",
"author_email": "EchterAlsFake@proton.me",
"download_url": "https://files.pythonhosted.org/packages/9b/5d/189f3ffb35b29892ab8b00bbe63f1889a9ad78d3d82e50a9877dece9afdf/spankbang_api-1.1.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">Spankbang API</h1> \n\n<div align=\"center\">\n <a href=\"https://pepy.tech/project/spankbang_api\"><img src=\"https://static.pepy.tech/badge/spankbang_api\" alt=\"Downloads\"></a>\n <a href=\"https://github.com/EchterAlsFake/spankbang_api/workflows/\"><img src=\"https://github.com/EchterAlsFake/spankbang_api/workflows/CodeQL/badge.svg\" alt=\"CodeQL Analysis\"/></a>\n <a href=\"https://github.com/EchterAlsFake/spankbang_api/workflows/\"><img src=\"https://github.com/EchterAlsFake/spankbang_api/actions/workflows/tests.yml/badge.svg\" alt=\"API Tests\"/></a>\n</div>\n\n# Description\n\nSpankbang API is an API for Spankbang. It allows you to fetch information from videos using regexes and requests.\n\n# Disclaimer\n\n> [!IMPORTANT] \n> Spankbang API is in violation to Spankbang's ToS!\n> If you are the website owner of spankbang.com, contact me at my E-Mail, and I'll take this repository immediately offline.\n> EchterAlsFake@proton.me\n\n> [!NOTE]\n> This API was made for my other project Porn Fetch, which is the reason why I keep it so minimal. If you have any features you need, please\n> just open an Issue and I will add that feature to this API. I will also add other features, later but my priority is primarily downloading videos!\n\n# Quickstart\n\n### Have a look at the [Documentation](https://github.com/EchterAlsFake/API_Docs/blob/master/Porn_APIs/Spankbang.md) for more details\n\n- Install the library with `pip install spankbang_api`\n- Or from git using `pip install git+https://github.com/EchterAlsFake/spankbang_api`\n\n\n```python\nfrom spankbang_api import Client, Quality\n# Initialize a Client object\nclient = Client()\n\n# Fetch a video\nvideo_object = client.get_video(\"<insert_url_here>\")\n\n# Get information from videos\nvideo_object.title\nvideo_object.rating\nvideo_object.description\n# See docs for more...\n\n# Download the video\nvideo_object.download(quality=Quality.BEST, path=\"your_output_path\")\n\n```\n\n\n# Changelog\nSee [Changelog](https://github.com/EchterAlsFake/spankbang_api/blob/master/README/Changelog.md) for more details.\n\n# Contribution\nDo you see any issues or having some feature requests? Simply open an Issue or talk\nin the discussions.\n\nPull requests are welcome :) \n\n# License\nLicensed under the LGPLv3 License\n\nCopyright (C) 2023\u20132024 Johannes Habel\n\n",
"bugtrack_url": null,
"license": "LGPLv3",
"summary": "A Python API for the Porn Site spankbang.com",
"version": "1.1",
"project_urls": {
"Homepage": "https://github.com/EchterAlsFake/spankbang_api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "845bb1a3fc82aaea8ac287c5ea7ea6d68a9f894e851cdf6f188e907ec1c9c1e9",
"md5": "2e60ca90ffff3171ce1ced639fccdb12",
"sha256": "c2db62c41c122688b731a6748153ef188871096c224a4c776d29ec6b8640124e"
},
"downloads": -1,
"filename": "spankbang_api-1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2e60ca90ffff3171ce1ced639fccdb12",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9549,
"upload_time": "2025-01-02T12:31:15",
"upload_time_iso_8601": "2025-01-02T12:31:15.540447Z",
"url": "https://files.pythonhosted.org/packages/84/5b/b1a3fc82aaea8ac287c5ea7ea6d68a9f894e851cdf6f188e907ec1c9c1e9/spankbang_api-1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9b5d189f3ffb35b29892ab8b00bbe63f1889a9ad78d3d82e50a9877dece9afdf",
"md5": "a629dec7f2914e5bf2428975f13f496e",
"sha256": "27a144faddb2c8959b537f5db7ea6a0becdd8460439ec0e4d0fb35df4b559fe8"
},
"downloads": -1,
"filename": "spankbang_api-1.1.tar.gz",
"has_sig": false,
"md5_digest": "a629dec7f2914e5bf2428975f13f496e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9130,
"upload_time": "2025-01-02T12:31:17",
"upload_time_iso_8601": "2025-01-02T12:31:17.835494Z",
"url": "https://files.pythonhosted.org/packages/9b/5d/189f3ffb35b29892ab8b00bbe63f1889a9ad78d3d82e50a9877dece9afdf/spankbang_api-1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-02 12:31:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "EchterAlsFake",
"github_project": "spankbang_api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "spankbang-api"
}
JSON
