spnkr


Namespnkr JSON
Version 0.9.4 PyPI version JSON
download
home_pageNone
SummaryPython API for retrieving Halo Infinite multiplayer data.
upload_time2024-10-18 04:23:29
maintainerNone
docs_urlNone
authorAndy Curtis
requires_python>=3.11
licenseCopyright 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 wrapper around the undocumented Halo Infinite web API. This is a personal project with the goal of analyzing Halo Infinite matchmaking data. It is not in any way official or connected to Microsoft/343 Industries and does not provide any guarantees of completeness or API availability. Use at your own risk. The functionality is available via a public repository on GitHub and as a package published to PyPI.

### 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
    - `bitstring` for unpacking data from binary film files

## Contributions

Contributions to fix issues or add support for more endpoints are welcomed.

            

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/d6/aa/7e23112675ce8e18b4b4139c66dc2c4ac74d10c6fab69b452b03bc1d28c8/spnkr-0.9.4.tar.gz",
    "platform": null,
    "description": "# Welcome to SPNKr\n\n## About\n\n[SPNKr](https://www.halopedia.org/M41_SPNKr) is a Python wrapper around the undocumented Halo Infinite web API. This is a personal project with the goal of analyzing Halo Infinite matchmaking data. It is not in any way official or connected to Microsoft/343 Industries and does not provide any guarantees of completeness or API availability. Use at your own risk. The functionality is available via a public repository on GitHub and as a package published to PyPI.\n\n### Links\n\n- [Documentation](https://acurtis166.github.io/SPNKr/)\n- [PyPI](https://pypi.org/project/spnkr/)\n- [GitHub](https://github.com/acurtis166/spnkr)\n\n## Acknowledgements\n\n- Xbox Live authentication flow: [OpenXbox/xbox-webapi-python](https://github.com/OpenXbox/xbox-webapi-python)\n- Halo Infinite authentication flow, endpoints, schema, enumerated data types: [Den Delimarsky](https://den.dev/blog/halo-api-authentication)\n- Microsoft/343 Industries\n\n## Disclaimer\n\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.\n\nAs the authentication process requires usage of personal credentials, **use at your own risk** of action by Microsoft or 343 Industries.\n\n## Dependencies\n\n- Python >= 3.11\n- Required Packages:\n    - `aiohttp` for making asyncronous HTTP requests\n    - `aiolimiter` for limiting requests per second\n    - `pydantic` for parsing responses into Pydantic models\n    - `bitstring` for unpacking data from binary film files\n\n## Contributions\n\nContributions to fix issues or add support for more endpoints are welcomed.\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.9.4",
    "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": "180a3ca6a38ff781fee007c1d0431f591238c14bca85a39fde61aec4559b17ba",
                "md5": "3291161cd521fac4d71317b168c7abea",
                "sha256": "74fb4cdaf35b6e476c3ee7216d341c4693a21b402f8654fbe84fbc8b9087f688"
            },
            "downloads": -1,
            "filename": "spnkr-0.9.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3291161cd521fac4d71317b168c7abea",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 50711,
            "upload_time": "2024-10-18T04:23:28",
            "upload_time_iso_8601": "2024-10-18T04:23:28.644874Z",
            "url": "https://files.pythonhosted.org/packages/18/0a/3ca6a38ff781fee007c1d0431f591238c14bca85a39fde61aec4559b17ba/spnkr-0.9.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d6aa7e23112675ce8e18b4b4139c66dc2c4ac74d10c6fab69b452b03bc1d28c8",
                "md5": "3df09517388bd22da5988f47dee57d9e",
                "sha256": "df60913c82b99df72d7158d598b8d3f6d3d56ded21786bb9833105bd1a366d94"
            },
            "downloads": -1,
            "filename": "spnkr-0.9.4.tar.gz",
            "has_sig": false,
            "md5_digest": "3df09517388bd22da5988f47dee57d9e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 41655,
            "upload_time": "2024-10-18T04:23:29",
            "upload_time_iso_8601": "2024-10-18T04:23:29.727693Z",
            "url": "https://files.pythonhosted.org/packages/d6/aa/7e23112675ce8e18b4b4139c66dc2c4ac74d10c6fab69b452b03bc1d28c8/spnkr-0.9.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-18 04:23:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "acurtis166",
    "github_project": "SPNKr",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "spnkr"
}
        
Elapsed time: 2.35173s