# Wattpad API
This is a no-compromise Wattpad API wrapper for python.
This project is still in development, and is not yet ready for production use.
It also speeds up the process by using disk caching, It will cache the response from the API and will only make a new request if the request is not cached.
This, of course can be disabled by setting the cache to False.
## Features
- Simple and easy to use
- Caches responses from the API to disk for faster response times
- Allows direct access to the API via the `fetch` method
- Allows exporting of the objects to DICT, JSON, or YAML
- Can directly parse a manifest file from a curseforge modpack
## Installation
```bash
pip install wattpad-api
```
## Usage
```python
from wattpad import Wattpad, Story
engine = Wattpad()
wounded_love = Story.from_id(336166598, engine)
print(wounded_love.title)
print(wounded_love.author)
```
## TODO
- [x] Implement the export methods
- [x] Implement the cache
- [x] Implement the fetch method
- [ ] Implement the search method
- [ ] Wrap the ENTIRE API
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/Advik-B/wattpad-api",
"name": "wattpad-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Wattpad, Wattpad Wrapper, Watppad API, API, Wrapper",
"author": "Advik",
"author_email": "<advik.b@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8e/ad/d4bee430e82bf99c12e65b654ee9bcefad8692755c4b96bbcc9d3c0747f2/wattpad_api-1.0.0.tar.gz",
"platform": null,
"description": "\r\n# Wattpad API\r\n\r\n\r\n\r\nThis is a no-compromise Wattpad API wrapper for python.\r\n\r\nThis project is still in development, and is not yet ready for production use.\r\n\r\nIt also speeds up the process by using disk caching, It will cache the response from the API and will only make a new request if the request is not cached.\r\n\r\n\r\n\r\nThis, of course can be disabled by setting the cache to False.\r\n\r\n\r\n\r\n## Features\r\n\r\n\r\n\r\n- Simple and easy to use\r\n\r\n- Caches responses from the API to disk for faster response times\r\n\r\n- Allows direct access to the API via the `fetch` method\r\n\r\n- Allows exporting of the objects to DICT, JSON, or YAML\r\n\r\n- Can directly parse a manifest file from a curseforge modpack\r\n\r\n\r\n\r\n## Installation\r\n\r\n\r\n\r\n```bash\r\n\r\npip install wattpad-api\r\n\r\n```\r\n\r\n\r\n\r\n## Usage\r\n\r\n\r\n\r\n```python\r\n\r\nfrom wattpad import Wattpad, Story\r\n\r\n\r\n\r\nengine = Wattpad()\r\n\r\nwounded_love = Story.from_id(336166598, engine)\r\n\r\n\r\n\r\nprint(wounded_love.title)\r\n\r\nprint(wounded_love.author)\r\n\r\n```\r\n\r\n\r\n\r\n## TODO\r\n\r\n\r\n\r\n- [x] Implement the export methods\r\n\r\n- [x] Implement the cache\r\n\r\n- [x] Implement the fetch method\r\n\r\n- [ ] Implement the search method\r\n\r\n- [ ] Wrap the ENTIRE API\r\n\r\n\r\n\r\n## Contributing\r\n\r\n\r\n\r\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\r\n\r\n\r\n\r\nPlease make sure to update tests as appropriate.\r\n\r\n\r\n\r\n## License\r\n\r\n\r\n\r\n[MIT](https://choosealicense.com/licenses/mit/)\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A no-compromises wrapper for the Wattpad API",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/Advik-B/wattpad-api"
},
"split_keywords": [
"wattpad",
" wattpad wrapper",
" watppad api",
" api",
" wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "15a445bfa6c41e4dc9e6b864b42db8d5e4dc7c97346b79d73324ab1bfe501ecc",
"md5": "d602baf805596061a2238a93183f4ba6",
"sha256": "436ee3fa59a59143dbdc20416eb531bcd5e6135b2bfe5bdb928543337021a108"
},
"downloads": -1,
"filename": "wattpad_api-1.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d602baf805596061a2238a93183f4ba6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 9751,
"upload_time": "2024-05-21T12:47:27",
"upload_time_iso_8601": "2024-05-21T12:47:27.578056Z",
"url": "https://files.pythonhosted.org/packages/15/a4/45bfa6c41e4dc9e6b864b42db8d5e4dc7c97346b79d73324ab1bfe501ecc/wattpad_api-1.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8eadd4bee430e82bf99c12e65b654ee9bcefad8692755c4b96bbcc9d3c0747f2",
"md5": "240d7d0af6e9156aa7ff198d9b224188",
"sha256": "03f049d68ae92d11fb0643be49c4e8804f5bc9a33ad1bd4dfead2da654758765"
},
"downloads": -1,
"filename": "wattpad_api-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "240d7d0af6e9156aa7ff198d9b224188",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8556,
"upload_time": "2024-05-21T12:47:29",
"upload_time_iso_8601": "2024-05-21T12:47:29.176932Z",
"url": "https://files.pythonhosted.org/packages/8e/ad/d4bee430e82bf99c12e65b654ee9bcefad8692755c4b96bbcc9d3c0747f2/wattpad_api-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-21 12:47:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Advik-B",
"github_project": "wattpad-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "wattpad-api"
}
JSON
