Destipy


NameDestipy JSON
Version 0.81 PyPI version JSON
download
home_page
SummaryAsynchronous Python Wrapper for the Bungie API
upload_time2023-12-24 14:48:50
maintainer
docs_urlNone
author
requires_python>=3.7
license
keywords bungie destiny async wrapper api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Destipy

This is a asynchronous Python Wrapper around the Bungie API. It allows one to send requests to all given endpoints of the Bungie API seen in their [Bungie.Net API Documentation](https://bungie-net.github.io/multi/index.html).

NOTE:

* The endpoints are parsed from the API documentation and are therefore not tested, some of them might not work or are missing parameters due to inconsistencies in the documentation.
* Some of the code is inspired or taken from [pydest](https://github.com/jgayfer/pydest/tree/master/pydest) and [aiobungie](https://github.com/nxtlo/aiobungie) so check them out!

## Features

* Every endpoint in the documentation is implemented, POST and GET.
* Download and Extraction of the manifest to a .content file.
* Download and Extraction of the manifest to a MongoDB database (COMING SOON).
* Logging with own logger or with the default logger by adding a file "logs/Destipy.log" ('logs' being a folder) in the root folder.

## Examples

Here are a few examples:

* [COMING SOON](https://www.youtube.com/watch?v=dQw4w9WgXcQ&ab_channel=RickAstley)
* [COMING SOON](https://www.youtube.com/watch?v=dQw4w9WgXcQ&ab_channel=RickAstley)
* [COMING SOON](https://www.youtube.com/watch?v=dQw4w9WgXcQ&ab_channel=RickAstley)

### Requirements

* aiohttp

Install `Destipy`:

```
pip install Destipy
```

In you project you can use it as a simple client without authentication by initialize a client with your Api Key like this:

```
from destipy.destiny_client import DestinyClient

client = DestinyClient(<API_KEY>)
user = await client.user.GetBungieNetUserById(<MEMBERSHIP_ID>)
```

If you plan on using a specific category of endpoints multiple times you can also use the endpoint category itself as a class:

```
from destipy.destiny_client import DestinyClient

client = DestinyClient(<API_KEY>)
user_endpoints = client.user
user = await user_endpoints.GetBungieNetUserById(<MEMBERSHIP_ID>)
```

## Contact

Discord: `sedam79`

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "Destipy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "bungie,destiny,async,wrapper,api",
    "author": "",
    "author_email": "Sedam <sedam.code@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/09/77/b07c360899988f0d351943d649b3411615ed4502824427bc97fb4145cd26/Destipy-0.81.tar.gz",
    "platform": null,
    "description": "# Destipy\n\nThis is a asynchronous Python Wrapper around the Bungie API. It allows one to send requests to all given endpoints of the Bungie API seen in their [Bungie.Net API Documentation](https://bungie-net.github.io/multi/index.html).\n\nNOTE:\n\n* The endpoints are parsed from the API documentation and are therefore not tested, some of them might not work or are missing parameters due to inconsistencies in the documentation.\n* Some of the code is inspired or taken from [pydest](https://github.com/jgayfer/pydest/tree/master/pydest) and [aiobungie](https://github.com/nxtlo/aiobungie) so check them out!\n\n## Features\n\n* Every endpoint in the documentation is implemented, POST and GET.\n* Download and Extraction of the manifest to a .content file.\n* Download and Extraction of the manifest to a MongoDB database (COMING SOON).\n* Logging with own logger or with the default logger by adding a file \"logs/Destipy.log\" ('logs' being a folder) in the root folder.\n\n## Examples\n\nHere are a few examples:\n\n* [COMING SOON](https://www.youtube.com/watch?v=dQw4w9WgXcQ&ab_channel=RickAstley)\n* [COMING SOON](https://www.youtube.com/watch?v=dQw4w9WgXcQ&ab_channel=RickAstley)\n* [COMING SOON](https://www.youtube.com/watch?v=dQw4w9WgXcQ&ab_channel=RickAstley)\n\n### Requirements\n\n* aiohttp\n\nInstall `Destipy`:\n\n```\npip install Destipy\n```\n\nIn you project you can use it as a simple client without authentication by initialize a client with your Api Key like this:\n\n```\nfrom destipy.destiny_client import DestinyClient\n\nclient = DestinyClient(<API_KEY>)\nuser = await client.user.GetBungieNetUserById(<MEMBERSHIP_ID>)\n```\n\nIf you plan on using a specific category of endpoints multiple times you can also use the endpoint category itself as a class:\n\n```\nfrom destipy.destiny_client import DestinyClient\n\nclient = DestinyClient(<API_KEY>)\nuser_endpoints = client.user\nuser = await user_endpoints.GetBungieNetUserById(<MEMBERSHIP_ID>)\n```\n\n## Contact\n\nDiscord: `sedam79`\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Asynchronous Python Wrapper for the Bungie API",
    "version": "0.81",
    "project_urls": null,
    "split_keywords": [
        "bungie",
        "destiny",
        "async",
        "wrapper",
        "api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "77a38040648f06207beced384a80802e42f76d554c26399ed3c57326089adacb",
                "md5": "ef65256347af3448ff1a65cee5100439",
                "sha256": "e043cc428b87e4532c6c512f00d7280ef5a5136868819109e7162dbf2f692196"
            },
            "downloads": -1,
            "filename": "Destipy-0.81-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ef65256347af3448ff1a65cee5100439",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 173540,
            "upload_time": "2023-12-24T14:48:48",
            "upload_time_iso_8601": "2023-12-24T14:48:48.377781Z",
            "url": "https://files.pythonhosted.org/packages/77/a3/8040648f06207beced384a80802e42f76d554c26399ed3c57326089adacb/Destipy-0.81-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0977b07c360899988f0d351943d649b3411615ed4502824427bc97fb4145cd26",
                "md5": "5f0d9a9fb2cd7c55ff18b720a31bf70b",
                "sha256": "52c41ab973ea30e31f0732d670e936f1f7961a94c789139594fc84a4976af3cd"
            },
            "downloads": -1,
            "filename": "Destipy-0.81.tar.gz",
            "has_sig": false,
            "md5_digest": "5f0d9a9fb2cd7c55ff18b720a31bf70b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 162710,
            "upload_time": "2023-12-24T14:48:50",
            "upload_time_iso_8601": "2023-12-24T14:48:50.122433Z",
            "url": "https://files.pythonhosted.org/packages/09/77/b07c360899988f0d351943d649b3411615ed4502824427bc97fb4145cd26/Destipy-0.81.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-24 14:48:50",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "destipy"
}
        
Elapsed time: 0.15585s