| Name | rswiki-wrapper JSON |
| Version |
0.0.6
JSON |
| download |
| home_page | |
| Summary | RS Wiki API Wrapper |
| upload_time | 2022-12-30 23:42:42 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2022 Garrett3Nelson 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 |
rswiki
runescape
osrs
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# RSWiki-Wrapper
RSWiki-Wrapper is an open-source Python library wrapping functionality of the RuneScape Wiki API. Its goal is to support all RuneScape Wiki API endpoints for both OldSchool RuneScape and RuneScape (aka RS3).
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Requirements
To begin using the wrapper, you can install with pip
`pip install rswiki-wrapper`
The package is imported with `import rswiki_wrapper` or `from rswiki_wrapper import Exchange`.
To begin developing and testing this wrapper, set up a python environment with the prerequisites noted in [requirements.txt](requirements.txt).
### Acceptable Use Policy
To interface properly with the RuneScape Wiki API, first review their [acceptable use policy](https://runescape.wiki/w/Help:APIs#Acceptable_use_policy).
To assist in the user setup, each child class accepts a `user_agent` parameter. Each user should identify a method of contact which will be submitted in each request header. This allows the RuneScape Wiki staff to contact you and correct any misbehaving queries. I recommend using the format `user_agent='{Project Name} - {Contact}'`. The library contains a generic user agent which identifies you as using this wrapper and will warn you to use a custom user agent.
## Usage
The project is written such that it exposes the full API responses for user interaction under `WikiQuery.response`. Users can review all aspects of the request response under this property. Each class also exposes two helpful properties:
* `WikiQuery.json` is a python dictionary format of the API response
* `WikiQuery.content` is the "useful" data returned by the query, typically formatted as a python dictionary or list of dictionaries, where applicable.
For detailed documentation on the various API endpoints exposed and sample usage, see the [project documentation](https://rswiki-wrapper.readthedocs.io/)
### API Endpoints
For information on the various acceptable routes, queries, and optional arguments see the following documentation:
* [MediaWiki API](https://runescape.wiki/api.php) for all requests related to RuneScape wiki. This endpoint is valid for both OldSchool RuneScape and RuneScape.
* [Weird Gloop API](https://api.weirdgloop.org/#/) for requests to use the WeirdGloop API, which provides data for the RuneScape Grand Exchange and RuneScape Information.
* [Real-Time API](https://oldschool.runescape.wiki/w/RuneScape:Real-time_Prices) for access to real-time Grand Exchange data. This endpoint is valid only for OldSchool RuneScape.
## Tests
Testing for this project is performed using PyTest. All tests are written in `/tests` and should confirm the `.content` is formatted correctly, confirm the response data matches the expected value (if possible) and confirm the response keys match the expected output format.
## Contributing
Pull requests are welcome. As a novice, I welcome all suggestions for improvements. For major changes, please open an issue to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
Raw data
{
"_id": null,
"home_page": "",
"name": "rswiki-wrapper",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "rswiki,runescape,osrs",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/58/7d/3e046757cf16cde74c04bc8574e4335de1fe70c094a1cc2892e62d14906d/rswiki-wrapper-0.0.6.tar.gz",
"platform": null,
"description": "# RSWiki-Wrapper\r\n\r\nRSWiki-Wrapper is an open-source Python library wrapping functionality of the RuneScape Wiki API. Its goal is to support all RuneScape Wiki API endpoints for both OldSchool RuneScape and RuneScape (aka RS3).\r\n\r\n## Getting Started\r\n\r\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\r\n\r\n### Requirements\r\n\r\nTo begin using the wrapper, you can install with pip \r\n\r\n`pip install rswiki-wrapper`\r\n\r\nThe package is imported with `import rswiki_wrapper` or `from rswiki_wrapper import Exchange`.\r\n\r\nTo begin developing and testing this wrapper, set up a python environment with the prerequisites noted in [requirements.txt](requirements.txt).\r\n\r\n### Acceptable Use Policy\r\n\r\nTo interface properly with the RuneScape Wiki API, first review their [acceptable use policy](https://runescape.wiki/w/Help:APIs#Acceptable_use_policy).\r\n\r\nTo assist in the user setup, each child class accepts a `user_agent` parameter. Each user should identify a method of contact which will be submitted in each request header. This allows the RuneScape Wiki staff to contact you and correct any misbehaving queries. I recommend using the format `user_agent='{Project Name} - {Contact}'`. The library contains a generic user agent which identifies you as using this wrapper and will warn you to use a custom user agent.\r\n\r\n## Usage\r\n\r\nThe project is written such that it exposes the full API responses for user interaction under `WikiQuery.response`. Users can review all aspects of the request response under this property. Each class also exposes two helpful properties:\r\n* `WikiQuery.json` is a python dictionary format of the API response\r\n* `WikiQuery.content` is the \"useful\" data returned by the query, typically formatted as a python dictionary or list of dictionaries, where applicable.\r\n\r\nFor detailed documentation on the various API endpoints exposed and sample usage, see the [project documentation](https://rswiki-wrapper.readthedocs.io/)\r\n\r\n### API Endpoints\r\n\r\nFor information on the various acceptable routes, queries, and optional arguments see the following documentation:\r\n* [MediaWiki API](https://runescape.wiki/api.php) for all requests related to RuneScape wiki. This endpoint is valid for both OldSchool RuneScape and RuneScape.\r\n* [Weird Gloop API](https://api.weirdgloop.org/#/) for requests to use the WeirdGloop API, which provides data for the RuneScape Grand Exchange and RuneScape Information. \r\n* [Real-Time API](https://oldschool.runescape.wiki/w/RuneScape:Real-time_Prices) for access to real-time Grand Exchange data. This endpoint is valid only for OldSchool RuneScape.\r\n\r\n## Tests\r\n\r\nTesting for this project is performed using PyTest. All tests are written in `/tests` and should confirm the `.content` is formatted correctly, confirm the response data matches the expected value (if possible) and confirm the response keys match the expected output format.\r\n\r\n## Contributing\r\n\r\nPull requests are welcome. As a novice, I welcome all suggestions for improvements. For major changes, please open an issue to discuss what you would like to change.\r\n\r\nPlease make sure to update tests as appropriate.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Garrett3Nelson 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": "RS Wiki API Wrapper",
"version": "0.0.6",
"split_keywords": [
"rswiki",
"runescape",
"osrs"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "be470be061e75e2f113716ccdbbc67b9",
"sha256": "db3c348874568192ab8e2d27b3f5c967b4d69cd3203bb6f42057f44c5c89930b"
},
"downloads": -1,
"filename": "rswiki_wrapper-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be470be061e75e2f113716ccdbbc67b9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6040132,
"upload_time": "2022-12-30T23:42:39",
"upload_time_iso_8601": "2022-12-30T23:42:39.729499Z",
"url": "https://files.pythonhosted.org/packages/f8/ed/3589143144c54fb7f6fc4357d8dc35cd5e99b3a635c8c19e636c389c3c9b/rswiki_wrapper-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "40ea4965d9746cc399e8105001f9bcc3",
"sha256": "fd297b76a50a2f5128c79db538d25bb44a9be13389e3f8f60e9a4ab577afa882"
},
"downloads": -1,
"filename": "rswiki-wrapper-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "40ea4965d9746cc399e8105001f9bcc3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5131096,
"upload_time": "2022-12-30T23:42:42",
"upload_time_iso_8601": "2022-12-30T23:42:42.398874Z",
"url": "https://files.pythonhosted.org/packages/58/7d/3e046757cf16cde74c04bc8574e4335de1fe70c094a1cc2892e62d14906d/rswiki-wrapper-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-30 23:42:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "rswiki-wrapper"
}
