helldivepy


Namehelldivepy JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryA Helldivers 2 API wrapper using the Diveharder API and the Helldivers Community API
upload_time2024-10-28 02:40:45
maintainerNone
docs_urlNone
authorAJXD2
requires_python<4.0,>=3.11
licenseMIT
keywords helldivers 2 api wrapper diveharder community
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Helldive.py

[![PyPI](https://img.shields.io/pypi/v/helldivepy.svg?label=PyPI&color=blue)](https://pypi.org/project/helldivepy/)
![PyPI - Downloads](https://img.shields.io/pypi/dm/helldivepy?color=brightgreen)
![GitHub License](https://img.shields.io/github/license/ajxd2/helldive.py?color=yellow)
[![Python Versions](https://img.shields.io/pypi/pyversions/helldivepy.svg?color=orange)](https://pypi.org/project/helldivepy/)
![GitHub contributors](https://img.shields.io/github/contributors/ajxd2/helldive.py?color=ff69b4)

> A simple Python library for diving deep into the [Helldivers Community API](https://github.com/helldivers-2/api) and [Diveharder API](https://github.com/helldivers-2/diveharder_api.py).

---

## ⚙️ Installation

To install **Helldive.py**, just use pip:

```bash
pip install helldive.py
```

## 🚀 Quickstart

Here's a super-quick example to get you diving right in:

```python
import helldivepy

client = helldivepy.ApiClient(user_agent="my-app", user_contact="email@example.com")

# Get the latest dispatches
dispatches = client.dispatch.get_dispatches()

print(dispatches)
# Output example
[
   Dispatch(id=0, published=datetime.datetime, type=0, message='Hello, World 1!'),
   Dispatch(id=1, published=datetime.datetime, type=0, message='Hello, World 2!'),
   Dispatch(id=2, published=datetime.datetime, type=0, message='Hello, World 3!')
 ]
```

## 🌟 Features

- **Easy API Access**: Communicate with the Helldivers Community API and Diveharder API without breaking a sweat.
- **Typed Data**: Get structured, easily readable data like dispatches, planets, and more!
- **Perfect for Projects**: Ideal for projects, bots, or just exploring Helldivers data.

---

## 🛠️ Contributing

Contributions are always welcome! If you’d like to make changes, feel free to submit a pull request. For major updates, open an issue first to discuss your ideas.

## 📄 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "helldivepy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.11",
    "maintainer_email": null,
    "keywords": "helldivers 2, api, wrapper, diveharder, community",
    "author": "AJXD2",
    "author_email": "aj@ajxd2.dev",
    "download_url": "https://files.pythonhosted.org/packages/e2/2a/e63d7010ce8852ee08d06a090efe3b2d52ba4c58db2fc39b8f2cd5e989ee/helldivepy-0.1.0.tar.gz",
    "platform": null,
    "description": "# Helldive.py\n\n[![PyPI](https://img.shields.io/pypi/v/helldivepy.svg?label=PyPI&color=blue)](https://pypi.org/project/helldivepy/)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/helldivepy?color=brightgreen)\n![GitHub License](https://img.shields.io/github/license/ajxd2/helldive.py?color=yellow)\n[![Python Versions](https://img.shields.io/pypi/pyversions/helldivepy.svg?color=orange)](https://pypi.org/project/helldivepy/)\n![GitHub contributors](https://img.shields.io/github/contributors/ajxd2/helldive.py?color=ff69b4)\n\n> A simple Python library for diving deep into the [Helldivers Community API](https://github.com/helldivers-2/api) and [Diveharder API](https://github.com/helldivers-2/diveharder_api.py).\n\n---\n\n## \u2699\ufe0f Installation\n\nTo install **Helldive.py**, just use pip:\n\n```bash\npip install helldive.py\n```\n\n## \ud83d\ude80 Quickstart\n\nHere's a super-quick example to get you diving right in:\n\n```python\nimport helldivepy\n\nclient = helldivepy.ApiClient(user_agent=\"my-app\", user_contact=\"email@example.com\")\n\n# Get the latest dispatches\ndispatches = client.dispatch.get_dispatches()\n\nprint(dispatches)\n# Output example\n[\n   Dispatch(id=0, published=datetime.datetime, type=0, message='Hello, World 1!'),\n   Dispatch(id=1, published=datetime.datetime, type=0, message='Hello, World 2!'),\n   Dispatch(id=2, published=datetime.datetime, type=0, message='Hello, World 3!')\n ]\n```\n\n## \ud83c\udf1f Features\n\n- **Easy API Access**: Communicate with the Helldivers Community API and Diveharder API without breaking a sweat.\n- **Typed Data**: Get structured, easily readable data like dispatches, planets, and more!\n- **Perfect for Projects**: Ideal for projects, bots, or just exploring Helldivers data.\n\n---\n\n## \ud83d\udee0\ufe0f Contributing\n\nContributions are always welcome! If you\u2019d like to make changes, feel free to submit a pull request. For major updates, open an issue first to discuss your ideas.\n\n## \ud83d\udcc4 License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Helldivers 2 API wrapper using the Diveharder API and the Helldivers Community API",
    "version": "0.1.0",
    "project_urls": {
        "documentation": "https://github.com/ajxd2/helldive.py#readme",
        "homepage": "https://github.com/ajxd2/helldive.py",
        "repository": "https://github.com/ajxd2/helldive.py"
    },
    "split_keywords": [
        "helldivers 2",
        " api",
        " wrapper",
        " diveharder",
        " community"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "712bbe8be9811571c40db4640c52f79576fffa3757d86f3f6e1107c700a6ba40",
                "md5": "ae594fceffe15fbde719cf969ad5505d",
                "sha256": "1f1a75d60b3fbeac26f8ea2901939207994fb87772407050f38d842e6bc6e72b"
            },
            "downloads": -1,
            "filename": "helldivepy-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ae594fceffe15fbde719cf969ad5505d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 13129,
            "upload_time": "2024-10-28T02:40:43",
            "upload_time_iso_8601": "2024-10-28T02:40:43.891757Z",
            "url": "https://files.pythonhosted.org/packages/71/2b/be8be9811571c40db4640c52f79576fffa3757d86f3f6e1107c700a6ba40/helldivepy-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e22ae63d7010ce8852ee08d06a090efe3b2d52ba4c58db2fc39b8f2cd5e989ee",
                "md5": "d4f4bad5c61db3cd80324a22bf62f862",
                "sha256": "25334c2f7131ede41d171df5191c3950c6006e033715a271f18f56fbe9027884"
            },
            "downloads": -1,
            "filename": "helldivepy-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d4f4bad5c61db3cd80324a22bf62f862",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 9425,
            "upload_time": "2024-10-28T02:40:45",
            "upload_time_iso_8601": "2024-10-28T02:40:45.628098Z",
            "url": "https://files.pythonhosted.org/packages/e2/2a/e63d7010ce8852ee08d06a090efe3b2d52ba4c58db2fc39b8f2cd5e989ee/helldivepy-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-28 02:40:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ajxd2",
    "github_project": "helldive.py#readme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "helldivepy"
}
        
Elapsed time: 0.59469s