Metadata-Version: 2.1
Name: corkus.py
Version: 0.4.1
Summary: A Python wrapper for the Wynncraft API
Home-page: https://github.com/MrBartusek/corkus.py
Author: MrBartusek
License: MIT
Project-URL: Documentation, https://corkuspy.readthedocs.io/en/latest/
Project-URL: Issue tracker, https://github.com/MrBartusek/corkus.py/issues
Description: ![corkus banner](https://i.imgur.com/8FjYte1.gif)
        
        
        [![build](https://img.shields.io/github/workflow/status/MrBartusek/corkus.py/build)](https://github.com/MrBartusek/corkus.py/actions) [![codecov](https://codecov.io/gh/MrBartusek/corkus.py/branch/main/graph/badge.svg?token=oZbLlhqRKJ)](https://codecov.io/gh/MrBartusek/corkus.py) [![Documentation Status](https://img.shields.io/readthedocs/corkuspy)](https://corkuspy.readthedocs.io/en/latest/?badge=latest) [![PyPI](https://img.shields.io/pypi/v/corkus.py)](https://pypi.org/project/corkus.py/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/corkus.py)](https://pypi.org/project/corkus.py/)
        
        # Corkus.py ⚙️
        
        Asynchronous, feature-rich and easy to use Python wrapper for [Public Wynncraft API](https://docs.wynncraft.com).
        
        ## Key Features
        
        - Modern asynchronous API using `async`/`await` syntax.
        - Easy to use with an object oriented design using `fetch` and helper functions.
        - 100% coverage of the Wynncraft API.
        - Proper rate limit handling that prevents 429s.
        - Responses caching to improve speed.
        
        ## Installation
        
        *Python 3.8+ or higher is required*
        
        ```shell
        pip install corkus.py
        ```
        
        Or install latest development version:
        
        ```shell
        pip install --upgrade git+https://github.com/MrBartusek/corkus.py@main
        ```
        
        See [documentation](https://corkuspy.readthedocs.io/en/latest/getting_started/installation.html) for more information.
        
        ## Quick Example
        
        Using [Context Manager](https://book.pythontips.com/en/latest/context_managers.html):
        
        ```python
        import asyncio
        from corkus import Corkus
        
        async def player_stats():
            async with Corkus() as corkus:
                player = await corkus.player.get("Salted")
                print(f"username: {player.username}")
                print(f"chests_found: {player.statistics.chests_found}")
        
        loop = asyncio.get_event_loop()
        loop.run_until_complete(player_stats())
        ```
        
        Without Context Manager:
        
        ```python
        import asyncio
        from corkus import Corkus
        
        async def player_stats():
            corkus = Corkus()
        
            player = await corkus.player.get("Salted")
            print(f"username: {player.username}")
            print(f"chests_found: {player.statistics.chests_found}")
        
            await corkus.close()
        
        loop = asyncio.get_event_loop()
        loop.run_until_complete(player_stats())
        ```
        
        Output:
        ```
        username: Salted
        chests_found: 219
        ```
        
        ## Links
        - [Documentation](https://corkuspy.readthedocs.io)
        - [PyPi Package](https://pypi.org/project/corkus.py/)
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.8.0
Description-Content-Type: text/markdown
