esihub


Nameesihub JSON
Version 0.0.4 PyPI version JSON
download
home_pagehttps://github.com/siege-green/esihub
SummaryAn asynchronous client library for EVE ONLINE ESI API
upload_time2024-07-18 12:38:44
maintainerNone
docs_urlNone
authorMelonCafe
requires_python<4.0,>=3.11
licenseMIT
keywords eve online sdk api esi
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ESIHub

[![PyPI version](https://badge.fury.io/py/esihub.svg)](https://badge.fury.io/py/esihub)
[![Python Versions](https://img.shields.io/pypi/pyversions/esihub.svg)](https://pypi.org/project/esihub/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![codecov](https://codecov.io/gh/meloncafe/esihub/graph/badge.svg?token=Q5Un3rLAsw)](https://codecov.io/gh/meloncafe/esihub)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

A high-performance, feature-rich Python client for the EVE Online ESI API

[Installation](#installation) •
[Quick Start](#quick-start) •
[Features](#features) •
[Documentation](#documentation) •
[Contributing](#contributing) •
[License](#license)

## Installation

ESIHub requires Python 3.11 or later. Install it with pip:

```bash
pip install esihub
```

## Quick Start

Here's a simple example to get you started:

```python
import asyncio
from esihub import ESIHubClient

async def main():
    client = ESIHubClient()

    async with client:
        # Get character information
        character_id = 12345
        character_info = await client.get_characters_character_id(character_id=character_id)
        print(f"Character Info: {character_info}")

asyncio.run(main())
```

## Features

- ⚡ **Asynchronous Operations**: Built on `aiohttp` for high performance
- 🔄 **Automatic Rate Limiting**: Stay within EVE Online's API guidelines
- 💾 **Efficient Caching**: Reduce unnecessary API calls with Redis integration
- 🔑 **Token Management**: Automatic token refresh and secure storage
- 🛡️ **Robust Error Handling**: Custom exceptions for different error scenarios
- 📝 **Comprehensive Logging**: Detailed logs for easy debugging
- 🎣 **Event Hooks**: Lifecycle events for request customization
- 📦 **Batch Processing**: Make multiple requests concurrently
- ⚙️ **Easy Configuration**: Simple setup with environment variables

## Documentation

For full documentation, please visit our [GitHub Pages](https://esihub.siege-green.com).

## Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details.

## License

ESIHub is released under the MIT License. See the [LICENSE](LICENSE) file for more details.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/siege-green/esihub",
    "name": "esihub",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.11",
    "maintainer_email": null,
    "keywords": "eve online, sdk, api, esi",
    "author": "MelonCafe",
    "author_email": "contact@siege-green.com",
    "download_url": "https://files.pythonhosted.org/packages/56/ca/de5e8081b5ebc16124b4edeb89aed4003f57493fb0eef7f43509739035fd/esihub-0.0.4.tar.gz",
    "platform": null,
    "description": "# ESIHub\n\n[![PyPI version](https://badge.fury.io/py/esihub.svg)](https://badge.fury.io/py/esihub)\n[![Python Versions](https://img.shields.io/pypi/pyversions/esihub.svg)](https://pypi.org/project/esihub/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![codecov](https://codecov.io/gh/meloncafe/esihub/graph/badge.svg?token=Q5Un3rLAsw)](https://codecov.io/gh/meloncafe/esihub)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nA high-performance, feature-rich Python client for the EVE Online ESI API\n\n[Installation](#installation) \u2022\n[Quick Start](#quick-start) \u2022\n[Features](#features) \u2022\n[Documentation](#documentation) \u2022\n[Contributing](#contributing) \u2022\n[License](#license)\n\n## Installation\n\nESIHub requires Python 3.11 or later. Install it with pip:\n\n```bash\npip install esihub\n```\n\n## Quick Start\n\nHere's a simple example to get you started:\n\n```python\nimport asyncio\nfrom esihub import ESIHubClient\n\nasync def main():\n    client = ESIHubClient()\n\n    async with client:\n        # Get character information\n        character_id = 12345\n        character_info = await client.get_characters_character_id(character_id=character_id)\n        print(f\"Character Info: {character_info}\")\n\nasyncio.run(main())\n```\n\n## Features\n\n- \u26a1 **Asynchronous Operations**: Built on `aiohttp` for high performance\n- \ud83d\udd04 **Automatic Rate Limiting**: Stay within EVE Online's API guidelines\n- \ud83d\udcbe **Efficient Caching**: Reduce unnecessary API calls with Redis integration\n- \ud83d\udd11 **Token Management**: Automatic token refresh and secure storage\n- \ud83d\udee1\ufe0f **Robust Error Handling**: Custom exceptions for different error scenarios\n- \ud83d\udcdd **Comprehensive Logging**: Detailed logs for easy debugging\n- \ud83c\udfa3 **Event Hooks**: Lifecycle events for request customization\n- \ud83d\udce6 **Batch Processing**: Make multiple requests concurrently\n- \u2699\ufe0f **Easy Configuration**: Simple setup with environment variables\n\n## Documentation\n\nFor full documentation, please visit our [GitHub Pages](https://esihub.siege-green.com).\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details.\n\n## License\n\nESIHub is released under the MIT License. See the [LICENSE](LICENSE) file for more details.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "An asynchronous client library for EVE ONLINE ESI API",
    "version": "0.0.4",
    "project_urls": {
        "Documentation": "https://esihub.siege-green.com",
        "Homepage": "https://github.com/siege-green/esihub",
        "Repository": "https://github.com/siege-green/esihub"
    },
    "split_keywords": [
        "eve online",
        " sdk",
        " api",
        " esi"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a36644910263237d9a0c87aac5b65d4592396a45ff8e12a4136b13445e67bd09",
                "md5": "b55af0f0eb09d7b0138ee40800d661a1",
                "sha256": "c5a641ca125165a1820232a38708433bd9b09f2552db3edd9eaf39853813e464"
            },
            "downloads": -1,
            "filename": "esihub-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b55af0f0eb09d7b0138ee40800d661a1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 98374,
            "upload_time": "2024-07-18T12:38:42",
            "upload_time_iso_8601": "2024-07-18T12:38:42.873919Z",
            "url": "https://files.pythonhosted.org/packages/a3/66/44910263237d9a0c87aac5b65d4592396a45ff8e12a4136b13445e67bd09/esihub-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "56cade5e8081b5ebc16124b4edeb89aed4003f57493fb0eef7f43509739035fd",
                "md5": "2bfe41f486f35ec9d30e414896e3af7a",
                "sha256": "8933f4302f3a7465a629e973be928c608cd1afd497caaecdbb1ed856e84489e1"
            },
            "downloads": -1,
            "filename": "esihub-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "2bfe41f486f35ec9d30e414896e3af7a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 93240,
            "upload_time": "2024-07-18T12:38:44",
            "upload_time_iso_8601": "2024-07-18T12:38:44.285303Z",
            "url": "https://files.pythonhosted.org/packages/56/ca/de5e8081b5ebc16124b4edeb89aed4003f57493fb0eef7f43509739035fd/esihub-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-18 12:38:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "siege-green",
    "github_project": "esihub",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "esihub"
}
        
Elapsed time: 0.74094s