| Name | spnkr JSON |
| Version |
0.7.0
JSON |
| download |
| home_page | None |
| Summary | Python API for retrieving Halo Infinite multiplayer data. |
| upload_time | 2024-04-26 03:22:11 |
| maintainer | None |
| docs_url | None |
| author | Andy Curtis |
| requires_python | >=3.11 |
| license | Copyright 2022 Andy Curtis 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 |
halo
infinite
api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Welcome to SPNKr
## About
[SPNKr](https://www.halopedia.org/M41_SPNKr) is a Python API for retrieving [Halo Infinite](https://www.halowaypoint.com/halo-infinite) multiplayer data. [Halo 5](https://www.halopedia.org/Halo_5:_Guardians), 343 Industries' previous entry in the FPS series, has a [public API](https://developer.haloapi.com/) available. Currently, there is no such public API available for Halo Infinite. This project began as an effort to replicate the functionality of the Halo 5 API for Python developers.
### Links
- [Documentation](https://acurtis166.github.io/SPNKr/)
- [PyPI](https://pypi.org/project/spnkr/)
- [GitHub](https://github.com/acurtis166/spnkr)
## Acknowledgements
- Xbox Live authentication flow: [OpenXbox/xbox-webapi-python](https://github.com/OpenXbox/xbox-webapi-python)
- Halo Infinite authentication flow, endpoints, schema, enumerated data types: [Den Delimarsky](https://den.dev/blog/halo-api-authentication)
- Microsoft/343 Industries
## Disclaimer
This software is not endorsed or supported by Microsoft or 343 Industries. It is a personal project with the goal of analyzing Halo Infinite match data.
As the authentication process requires usage of personal credentials, **use at your own risk** of action by Microsoft or 343 Industries.
## Dependencies
- Python >= 3.11
- Required Packages:
- `aiohttp` for making asyncronous HTTP requests
- `aiolimiter` for limiting requests per second
- `pydantic` for parsing responses into Pydantic models
Raw data
{
"_id": null,
"home_page": null,
"name": "spnkr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "halo, infinite, api",
"author": "Andy Curtis",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/2f/66/190f7b4be2950cbd8422098c2669352186af8bcbfad0e0aa45f75aba0011/spnkr-0.7.0.tar.gz",
"platform": null,
"description": "# Welcome to SPNKr\r\n\r\n## About\r\n\r\n[SPNKr](https://www.halopedia.org/M41_SPNKr) is a Python API for retrieving [Halo Infinite](https://www.halowaypoint.com/halo-infinite) multiplayer data. [Halo 5](https://www.halopedia.org/Halo_5:_Guardians), 343 Industries' previous entry in the FPS series, has a [public API](https://developer.haloapi.com/) available. Currently, there is no such public API available for Halo Infinite. This project began as an effort to replicate the functionality of the Halo 5 API for Python developers.\r\n\r\n### Links\r\n\r\n- [Documentation](https://acurtis166.github.io/SPNKr/)\r\n- [PyPI](https://pypi.org/project/spnkr/)\r\n- [GitHub](https://github.com/acurtis166/spnkr)\r\n\r\n## Acknowledgements\r\n\r\n- Xbox Live authentication flow: [OpenXbox/xbox-webapi-python](https://github.com/OpenXbox/xbox-webapi-python)\r\n- Halo Infinite authentication flow, endpoints, schema, enumerated data types: [Den Delimarsky](https://den.dev/blog/halo-api-authentication)\r\n- Microsoft/343 Industries\r\n\r\n## Disclaimer\r\n\r\nThis software is not endorsed or supported by Microsoft or 343 Industries. It is a personal project with the goal of analyzing Halo Infinite match data.\r\n\r\nAs the authentication process requires usage of personal credentials, **use at your own risk** of action by Microsoft or 343 Industries.\r\n\r\n## Dependencies\r\n\r\n- Python >= 3.11\r\n- Required Packages:\r\n - `aiohttp` for making asyncronous HTTP requests\r\n - `aiolimiter` for limiting requests per second\r\n - `pydantic` for parsing responses into Pydantic models\r\n",
"bugtrack_url": null,
"license": "Copyright 2022 Andy Curtis 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": "Python API for retrieving Halo Infinite multiplayer data.",
"version": "0.7.0",
"project_urls": {
"Documentation": "https://acurtis166.github.io/SPNKr/",
"Homepage": "https://github.com/acurtis166/SPNKr"
},
"split_keywords": [
"halo",
" infinite",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23de2152dc3f9662641fb85b6ac5189d53847895d5b21156c114a2cb07e79627",
"md5": "b08d626286800834f09ef3aded78ac32",
"sha256": "2eec04bae01e4e130df856cc60d784dad490fe210a92fd8f52587315f9c7c8b2"
},
"downloads": -1,
"filename": "spnkr-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b08d626286800834f09ef3aded78ac32",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 39880,
"upload_time": "2024-04-26T03:22:09",
"upload_time_iso_8601": "2024-04-26T03:22:09.613446Z",
"url": "https://files.pythonhosted.org/packages/23/de/2152dc3f9662641fb85b6ac5189d53847895d5b21156c114a2cb07e79627/spnkr-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2f66190f7b4be2950cbd8422098c2669352186af8bcbfad0e0aa45f75aba0011",
"md5": "961bfe1e7623fba8505b24515d1d7e36",
"sha256": "d716f9247209a8ac7aa4a7dadda868d8754d2ac99aa55293edcb637fc7bfc7be"
},
"downloads": -1,
"filename": "spnkr-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "961bfe1e7623fba8505b24515d1d7e36",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 32659,
"upload_time": "2024-04-26T03:22:11",
"upload_time_iso_8601": "2024-04-26T03:22:11.452276Z",
"url": "https://files.pythonhosted.org/packages/2f/66/190f7b4be2950cbd8422098c2669352186af8bcbfad0e0aa45f75aba0011/spnkr-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 03:22:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "acurtis166",
"github_project": "SPNKr",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "spnkr"
}
