aiobungie 0.2.11

A Python and Asyncio API wrapper for Bungie's API.

aiobungie

A statically typed, asynchronous API wrapper for building clients for Bungie's API in Python.

Installing

Currently Python 3.10, 3.11 and 3.12 are supported.

Stable release.

pip install aiobungie

Development via github master.

pip install git+https://github.com/nxtlo/aiobungie@master

Quick Example

See Examples for advance usage.

import aiobungie

client = aiobungie.Client('YOUR_API_KEY')

async def main() -> None:
    # Fetch a Destiny 2 character passing a component.
    # This includes Equipments, Inventory, Records, etc.
    async with client.rest:
        my_warlock = await client.fetch_character(
            member_id=4611686018484639825,
            membership_type=aiobungie.MembershipType.STEAM,
            character_id=2305843009444904605,
            components=[aiobungie.ComponentType.CHARACTER_EQUIPMENT],
        )
        # Other components will be populated when passed to `components=[...]`
        # Otherwise will be `None`

        # Make sure the component is fetched.
        assert my_warlock.equipment is not None

        # Get the first item equipped on this character.
        item = my_warlock.equipment[0]
        print(item.hash, item.location)

        # Fetch this item, Note that this performs an HTTP request.
        # Alternatively, You can use the manifest here instead.
        # See examples folder for more information.
        item = await client.fetch_inventory_item(item.hash)
        print(item.name, item.type_and_tier_name)
        # Prints: Izanagi's Burden Exotic Sniper Rifle

# You can either run it using the client or just asyncio.run(main())
client.run(main())

RESTful clients

aiobungie also provides a stand-alone RESTClient / RESTPool which's what Client built on top of, These clients just provide a lower-level abstraction.

A key note is that any Client based user can access the RESTClient instance bound to it with .rest property.

Key Features

• Lower level, allows to read and deserialize the JSON objects yourself.
• RESTClients do not turn response payloads into one of aiobungie.crates object.
• RESTful, You can use this as your REST API client in backend directly.
• Both Manifest and OAuth methods are usable directly.

Example

import aiobungie
import asyncio

# Single REST client connection.
client = aiobungie.RESTClient("...")

async def main() -> None:
    async with client:
        # Download and open the JSON manifest.
        manifest = await client.download_json_manifest(name="latest_manifest")
        with manifest.open("r") as file:
            data = file.read()

        # OAuth2 API. 2 simple methods for fetching and refreshing tokens.
        tokens = await client.fetch_oauth2_tokens('code')
        refreshed_tokens = await client.refresh_access_token(tokens.refresh_token)

        # Testing your own requests.
        response = await client.static_request(
            "GET", # Method.
            "Destiny2/path/to/route", # Route.
            auth="optional_access_token", # If the method requires OAuth2.
            json={"some_key": "some_value"} # If you need to pass JSON data.
        )

asyncio.run(main())

Dependancies

• aiohttp
• attrs
• backports.datetime_fromisoformat, required for Python 3.10 only.

Features

aiobungie features are extra dependencies that replaces the standard library with either faster/neater pkgs.

• speedup This will include and uses orjson or ujson as the default json parser. They provide faster json serialization and de-serialization than the standard Python JSON pkg.
• full: This will include all of the features above.

For installing the specified feature, type pip install aiobungie[feature-name]

Contributing

Please read this manual

Related Projects

If you have used aiobungie and want to show your work, Feel free to Open a PR including it.

• Fated: A Discord BOT that uses aiobungie.

Useful Resources

• Discord Username: vfate
• aiobungie Documentation: Here.
• BungieAPI Discord: Here
• Official Bungie Documentation: Here
• Bungie Developer Portal: Here

Additional information

If you have any question you can either open a blank issue, open a new github discussion, or just tag me in BungieAPI discord server.