Merge pull request #6 from lockwooddev/feature/#5

#5 - Add Game Data API's

Author: lockwooddev

CHANGELOG.md

@@ -1,9 +1,20 @@
 # Changelog
 
-## 2.0.0
+## 2.0.0 (14-10-2018)
 
 * Deprecate 1.0 WowApi
 * Implement client credentials flow for OAuth authentication
 * Add dronefile for testing against multiple python versions
 * Add coverage to pytest
-* Add logging
+* Add logging
+
+## 2.0.1 (Unreleased)
+
+* Add drone cloud support for CI
+* Bump requests library to 2.20.1
+* Change packaging with setup.py
+
+## 2.1.0 (TBD)
+
+* Add Game Data API methods
+* Token handling per region

MANIFEST.in

@@ -7,7 +7,6 @@ include LICENSE.txt
 include Makefile
 include pytest.ini
 recursive-include docs *
-recursive-exclude docs/_build *
-recursive-exclude * *.pyc
-recursive-exclude * *.pyo
-recursive-exclude * *.DS_Store
+recursive-exclude * *.py[co]
+recursive-exclude * *.DS_Store
+recursive-exclude * __pycache__

Makefile

@@ -1,4 +1,4 @@
-.PHONY: tests devinstall docs clean build test_publish publish
+.PHONY: tests devinstall docs clean clean_build build test_publish publish
 
 
 tests:
@@ -15,6 +15,8 @@ docs: clean
 	$(MAKE) -C docs html
 
 build:
+	rm -rf dist
+	rm -rf build
 	python setup.py sdist bdist_wheel
 
 test_publish:

README.md

@@ -1,31 +1,72 @@
 # python-wowapi
 
+
+[![](https://img.shields.io/pypi/v/python-wowapi.svg)]( [![](https://img.shields.io/pypi/pyversions/:python-wowapi.svg)](https://pypi.org/project/python-wowapi/))
+[![](https://img.shields.io/pypi/pyversions/python-wowapi.svg)](https://pypi.org/project/python-wowapi/)
 [![Build Status](https://cloud.drone.io/api/badges/lockwooddev/python-wowapi/status.svg)](https://cloud.drone.io/lockwooddev/python-wowapi)
 
+
+
 Python-wowapi is a client library for interacting with the World of Warcraft
-Community API.
+Community and Game Data API.
+
+To interact with this library, you need to first get a client-id and client secret by registering [here](https://develop.battle.net/access)
 
-Documentation about installing and usage can be found at [python-wowapi.readthedocs.org](https://python-wowapi.readthedocs.org)
+For more information about official World of Warcraft API's visit:
+[Official API documentation](https://develop.battle.net/documentation)
+[Official API Forum](https://us.battle.net/forums/en/bnet/15051532/)
+
+API documentation can be found at [python-wowapi.readthedocs.org](https://python-wowapi.readthedocs.org). Examples and installation instructions are documented here.
 
 ## Installing
 
 ```bash
 pip install python-wowapi
 ```
 
-## Usage
+## API instance
 
 ```python
 import os
 
 from wowapi import WowApi
 
-
 api = WowApi(os.environ['WOW_CLIENT_ID'], os.environ['WOW_CLIENT_SECRET'])
-data = api.get_auctions('eu', 'silvermoon', locale='de_DE')
-print(data)
 ```
 
+## Community API example
+
+```python
+api.get_auctions('eu', 'silvermoon', locale='de_DE')
+```
+
+
+## Game Data API examples
+
+
+### Get token price
+```python
+api.get_token('eu', namespace='dynamic-eu', locale='de_DE')
+```
+
+### Get class specializations and detail specialization resource
+```python
+data = api.get_playable_specializations('us', namespace='static-us')
+
+spec_id = data['character_specializations'][0]['id']
+specialization = api.get_playable_specialization('us', namespace='static-us', spec_id=spec_id)
+```
+
+### Get game data resource by url
+
+This example shows how to fetch a game data resource by url.
+The `get_data_resource` method will take care of adding your access_token to the url.
+
+```python
+api.get_data_resource('https://eu.api.blizzard.com/data/wow/connected-realm/509?namespace=dynamic-eu', region='eu')
+```
+
+
 ## Development & Testing
 
 ```bash

docs/conf.py

@@ -21,8 +21,8 @@
 year = datetime.datetime.now().strftime('%Y')
 copyright ='{0}, Carlo Smouter'.format(year)
 
-version = '2.0.0'
-release = '2.0.0'
+version = '2.1.0'
+release = '2.1.0'
 
 exclude_patterns = ['_build']
 

docs/index.rst

@@ -1,83 +1,14 @@
 Python-wowapi
 =============
 
-Python-wowapi is a client library for interacting with the World of Warcraft Community API.
+For install instructions and examples visit the:
+`github readme <https://github.com/lockwooddev/python-wowapi/blob/master/README.md>`_
 
-This library requires a client-id and client secret for the Community API OAuth client credentials flow.
 
-For more information visit:
-
-- `Official API documentation <https://develop.battle.net/documentation>`_
-- `Official API Forum <https://us.battle.net/forums/en/bnet/15051532/>`_
-
-
-Usage
------
-
-::
-
-    >>> from wowapi import WowApi
-    >>> api = WowApi('client-id', 'client-secret')
-    >>> item = api.get_item('eu', 9999)
-
-    {
-        "id": 9999,
-        "disenchantingSkillRank": 125,
-        "description": "",
-        "name": "Black Mageweave Leggings",
-        "icon": "inv_pants_09",
-        ...
-    }
-
-::
-
-    >>> item = api.get_item('eu', 9999, locale='de_DE')
-
-    {
-        "id": 9999,
-        "disenchantingSkillRank": 125,
-        "description": "",
-        "name": "Schwarze Magiestoffgamaschen",
-        "icon": "inv_pants_09",
-        ...
-    }
-
-
-Api endpoints
--------------
+API
+---
 
 .. toctree::
    :maxdepth: 3
 
    modules/modules
-
-
-Installation
-------------
-
-Install the package with ``pip`` in your terminal::
-
-    pip install python-wowapi
-
-
-Or install the package directly from Github::
-
-    pip install git+https://github.com/lockwooddev/python-wowapi.git
-
-
-Running tests
--------------
-
-.. code-block:: bash
-
-    $ make devinstall
-    $ make tests
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-

examples/main.py renamed to examples/community.py

@@ -13,7 +13,7 @@
 handler.setFormatter(formatter)
 logger.addHandler(handler)
 
-logger.info('WowApi example')
+logger.info('Community API Example')
 
 api = WowApi(os.environ['WOW_CLIENT_ID'], os.environ['WOW_CLIENT_SECRET'])
 data = api.get_auctions('eu', 'silvermoon', locale='de_DE')

examples/game_data.py

@@ -0,0 +1,33 @@
+import logging
+import os
+from pprint import pprint
+
+from wowapi import WowApi
+
+
+logger = logging.getLogger('wowapi')
+logger.setLevel(logging.INFO)
+handler = logging.StreamHandler()
+handler.setLevel(logging.INFO)
+formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+handler.setFormatter(formatter)
+logger.addHandler(handler)
+
+logger.info('Game Data API Example')
+
+# fetch token price for region
+api = WowApi(os.environ['WOW_CLIENT_ID'], os.environ['WOW_CLIENT_SECRET'])
+data = api.get_token('eu', namespace='dynamic-eu', locale='de_DE')
+pprint(data)
+
+# get realm list and request detail href with the get_data_resource method
+data = api.get_realms('us', namespace='dynamic-us')
+detail_url = data['realms'][0]['key']['href']
+detail_data = api.get_data_resource(detail_url, region='us')
+pprint(detail_data)
+
+# get playable specializations list and fetch a single specialization with the api
+data = api.get_playable_specializations('us', namespace='static-us')
+spec_id = data['character_specializations'][0]['id']
+specialization = api.get_playable_specialization('us', namespace='static-us', spec_id=spec_id)
+pprint(specialization)

setup.py

@@ -1,9 +1,9 @@
 import os
 import codecs
-from setuptools import setup
+from setuptools import setup, find_packages
 
 
-__version__ = '2.0.0'
+__version__ = '2.1.0'
 
 
 def read(*parts):
@@ -17,7 +17,7 @@ def read(*parts):
 ]
 
 test_requirements = [
-    'pytest==3.8.2',
+    'pytest==4.0.1',
     'pytest-flakes==4.0.0',
     'pytest-pep8==1.0.6',
     'pytest-cov==2.6.0',
@@ -38,13 +38,15 @@ def read(*parts):
     author='Carlo Smouter',
     author_email='[email protected]',
     url='https://github.com/lockwooddev/python-wowapi',
+    packages=find_packages(exclude=['tests', 'tests.*']),
+    include_package_data=True,
     install_requires=install_requirements,
     extras_require={
         'tests': test_requirements,
         'docs': docs_requirements,
     },
     license='MIT',
-    keywords=['warcraft', 'api', 'wow', 'auctionhouse', 'community'],
+    keywords=['warcraft', 'api', 'wow', 'auctionhouse', 'community', 'game'],
     classifiers=[
         'Development Status :: 4 - Beta',
         'Intended Audience :: Developers',
@@ -57,9 +59,4 @@ def read(*parts):
         'Programming Language :: Python :: 3.7',
         'Topic :: Internet :: WWW/HTTP',
     ],
-    packages=[
-        'wowapi',
-        'tests',
-        'docs',
-    ],
 )