Metadata-Version: 2.1
Name: battlemuffin
Version: 0.1.0
Summary: A Pythin implementation of Blizzard's Web API.
Home-page: https://github.com/tehmufifnman/BattleMuffin-Python
Author: Brandon Nelson
Author-email: theredraver@gmail.com
License: MIT
Description: BattleMuffin
        ************
        |Build Status| |Coverage Status| |Code Style|
        
        Python Implementation of Blizzard's Web API
        
        BattleMuffin officially supports Python 3.5-3.8.
        
        Requirements
        ============
        
        This package requires client credentials from Blizzard.
        
        You can find out more about how to generate these credentials for your project at the `Blizzard Developer Portal`_.
        
        .. _`Blizzard Developer Portal`: https://develop.battle.net/
        
        Quick Setup
        ===========
        Some easy examples to get you started!
        
        .. code-block:: python
        
           from battlemuffin.clients.warcraft_client import WarcraftClient
        
        
           client = new WarcraftClient("CLIENT_ID", "CLIENT_SECRET")
           response = client.get_achievement_categories_index()
        
        It is possible to specify a region, using its default locale
        
        .. code-block:: python
        
           from battlemuffin.clients.warcraft_client import WarcraftClient
           from battlemuffin.config.region_config import Region
        
        
           client = new WarcraftClient("CLIENT_ID", "CLIENT_SECRET", Region.eu)
           response = client.get_achievement_categories_index()
        
        It is also possible to specify both the region and locale
        
        .. code-block:: python
        
           from battlemuffin.clients.warcraft_client import WarcraftClient
           from battlemuffin.config.region_config import Region, Locale
        
        
           client = WarcraftClient(client_id, client_secret, Region.eu, Locale.es_ES)
           response = client.get_achievement_categories_index()
        
        Installation
        ============
        
        To install the latest stable release, you can use ``pip`` (or ``pipenv``):
        
        ::
        
            $ pip install -U battlemuffin
        
        .. |Build Status| image:: https://github.com/tehmufifnman/BattleMuffin-Python/workflows/BattleMuffin-Python/badge.svg
           :target: https://github.com/tehmufifnman/BattleMuffin-Python/actions
        .. |Code Style| image:: https://img.shields.io/badge/code%20style-black-000000.svg
           :target: https://github.com/ambv/black
           :alt: Code style: black
        .. |Coverage Status| image:: https://codecov.io/gh/tehmufifnman/BattleMuffin-Python/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/tehmufifnman/BattleMuffin-Python
        
Keywords: blizzard api world-of-warcraft wow python
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Provides-Extra: tests
