hd2api.py


Namehd2api.py JSON
Version 0.0.0.18 PyPI version JSON
download
home_pageNone
SummaryAn API wrapper for the Helldivers 2 Community and official APIs
upload_time2024-11-11 19:01:41
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8.1
licenseNone
keywords helldivers2 api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Helldivers 2 Python API Wrapper

This is an asyncronous api frontend library for the Helldivers 2 API and many of it's community wrappers.

Get the latest game state from Helldivers 2,
and transform the raw data into collated
data objects complete with important planet effects,
the latest biome and enviornmental hazards,
and more.

Still currently in development, expect frequent updates
as the static data required by the package to
build the collated objects can change in between patches to Helldivers 2.

All returned objects are Pydantic Models,
which allow them to be quickly dumped and loaded
from/to json strings.

Please note, this API Wrapper was designed to 
primarily work with the asyncio module.  

Requirements:
 * httpx
 * pydantic

This front end supports:

* The community api.
https://github.com/helldivers-2/api

* The diveharder api.
https://github.com/helldivers-2/diveharder_api.py/

* Arrowhead's official API.


### current stable installation
```
 pip install -U hd2api.py
```
### current latest installation
```
 pip install -U git+https://github.com/CrosswaveOmega/hd2api.py.git
```


### Basic usage
```python
import asyncio
from hd2api import GetApiRawAll, ApiConfig, build_planet_2
async def main():
    apiconfig=ApiConfig()
    allval=await GetApiRawAll(apiconfig)
    print(allval.status)
    planet=build_planet_2(64,allval, apiconfig.staticdata())
    print(planet)


asyncio.run(main)
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "hd2api.py",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8.1",
    "maintainer_email": null,
    "keywords": "helldivers2, api",
    "author": null,
    "author_email": "Crosswave Omega <taucetivse@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/e5/80/a469c3ed1ad9daa29fb56f525d42391066812a43d67fb5875ddee9136e5b/hd2api_py-0.0.0.18.tar.gz",
    "platform": null,
    "description": "# Helldivers 2 Python API Wrapper\n\nThis is an asyncronous api frontend library for the Helldivers 2 API and many of it's community wrappers.\n\nGet the latest game state from Helldivers 2,\nand transform the raw data into collated\ndata objects complete with important planet effects,\nthe latest biome and enviornmental hazards,\nand more.\n\nStill currently in development, expect frequent updates\nas the static data required by the package to\nbuild the collated objects can change in between patches to Helldivers 2.\n\nAll returned objects are Pydantic Models,\nwhich allow them to be quickly dumped and loaded\nfrom/to json strings.\n\nPlease note, this API Wrapper was designed to \nprimarily work with the asyncio module.  \n\nRequirements:\n * httpx\n * pydantic\n\nThis front end supports:\n\n* The community api.\nhttps://github.com/helldivers-2/api\n\n* The diveharder api.\nhttps://github.com/helldivers-2/diveharder_api.py/\n\n* Arrowhead's official API.\n\n\n### current stable installation\n```\n pip install -U hd2api.py\n```\n### current latest installation\n```\n pip install -U git+https://github.com/CrosswaveOmega/hd2api.py.git\n```\n\n\n### Basic usage\n```python\nimport asyncio\nfrom hd2api import GetApiRawAll, ApiConfig, build_planet_2\nasync def main():\n    apiconfig=ApiConfig()\n    allval=await GetApiRawAll(apiconfig)\n    print(allval.status)\n    planet=build_planet_2(64,allval, apiconfig.staticdata())\n    print(planet)\n\n\nasyncio.run(main)\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "An API wrapper for the Helldivers 2 Community and official APIs",
    "version": "0.0.0.18",
    "project_urls": {
        "Documentation": "https://hd2apipy.readthedocs.io/en/latest/",
        "Source": "https://github.com/CrosswaveOmega/hd2api.py",
        "Tracker": "https://github.com/CrosswaveOmega/hd2api.py/issues"
    },
    "split_keywords": [
        "helldivers2",
        " api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "733d57f5f9dace3011fa841421c01103000ce897f34a54104be02c61083663d9",
                "md5": "4c19cf82f3891c1ffc2944f6e380e800",
                "sha256": "4b1a874ae771d6dfa44e6bab3f7a4ed023122540a1775d9909a0f73d2e9d2c48"
            },
            "downloads": -1,
            "filename": "hd2api.py-0.0.0.18-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4c19cf82f3891c1ffc2944f6e380e800",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.1",
            "size": 98186,
            "upload_time": "2024-11-11T19:01:40",
            "upload_time_iso_8601": "2024-11-11T19:01:40.326325Z",
            "url": "https://files.pythonhosted.org/packages/73/3d/57f5f9dace3011fa841421c01103000ce897f34a54104be02c61083663d9/hd2api.py-0.0.0.18-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e580a469c3ed1ad9daa29fb56f525d42391066812a43d67fb5875ddee9136e5b",
                "md5": "fe32913dd222fd86b500d532e5b9618d",
                "sha256": "e588c6f426f83f78a1429c17cb18aa08f6edc4bd5a94d373f993dceeb05c576b"
            },
            "downloads": -1,
            "filename": "hd2api_py-0.0.0.18.tar.gz",
            "has_sig": false,
            "md5_digest": "fe32913dd222fd86b500d532e5b9618d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.1",
            "size": 79296,
            "upload_time": "2024-11-11T19:01:41",
            "upload_time_iso_8601": "2024-11-11T19:01:41.992906Z",
            "url": "https://files.pythonhosted.org/packages/e5/80/a469c3ed1ad9daa29fb56f525d42391066812a43d67fb5875ddee9136e5b/hd2api_py-0.0.0.18.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-11 19:01:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "CrosswaveOmega",
    "github_project": "hd2api.py",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "hd2api.py"
}
        
Elapsed time: 1.63384s