New profile, game data and community endpoints (#14)

Author: lockwooddev

.drone.yml

@@ -1,43 +1,32 @@
 ---
 kind: pipeline
-name: python27
-
-steps:
-- name: test
-  image: python:2.7-alpine3.8
-  commands:
-    - ./drone.sh
-    - pytest -c pytest_legacy.ini
-
----
-kind: pipeline
+type: docker
 name: python35
 
 steps:
 - name: test
   image: python:3.5-alpine3.8
   commands:
     - ./drone.sh
-    - pytest -c pytest_legacy.ini
 
 ---
 kind: pipeline
+type: docker
 name: python36
 
 steps:
 - name: test
   image: python:3.6-alpine3.8
   commands:
     - ./drone.sh
-    - pytest
 
 ---
 kind: pipeline
+type: docker
 name: python37
 
 steps:
 - name: test
   image: python:3.7-alpine3.8
   commands:
     - ./drone.sh
-    - pytest

.gitignore

@@ -8,4 +8,7 @@ MANIFEST
 docs/_build/
 .coverage
 env/
-.cache
+.cache
+.vscode
+cov_html/
+.pytest_cache

.isort.cfg

@@ -0,0 +1,4 @@
+[settings]
+line_length=99
+multi_line_output=6
+lines_after_imports=2

CHANGELOG.md

@@ -34,3 +34,47 @@
 ## 2.3.1 (20-05-2019)
 
 * Added some leeway protection against expired tokens
+
+## 3.0.0
+
+* Split community, game data and profile API's into separate mixins
+* Add flake8 and isort to test requirements
+* Drop support for python 2.7
+* Changes in game data endpoints:
+    * `get_races` became `get_playable_race_index`
+    * `get_race` became `get_playable_race`
+    * `get_connected_realms` became `get_connected_realm_index`
+    * `get_mythic_keystone_dungeon` became `get_mythic_keystone_dungeon_index`
+    * `get_mythic_keystones` became `get_mythic_keystone_index`
+    * `get_mythic_keystone_periods` became `get_mythic_keystone_period_index`
+    * `get_mythic_keystone_seasons` became `get_mythic_keystone_season_index`
+    * `get_mythic_keystone_leaderboards` became `get_mythic_keystone_leaderboard_index`
+    * `get_playable_specializations` became `get_playable_specialization_index`
+    * `get_power_types` became `get_power_type_index`
+    * `get_realms` became `get_realm_index`
+    * `get_regions` became `get_region_index`
+    * `get_token` became `get_token_index`
+    * new achievments endpoints
+    * new creatures endpoints
+    * new guild endpoints
+    * new guild crest endpoints
+    * new item endpoints
+    * new mount endpoints
+    * new pets endpoints
+    * new pvp endpoints
+    * new quest endpoints
+    * new pvp season endpoints
+    * new pvp tier endpoints
+    * new titles endpoints
+* Changes in profile endpoints:
+    * new character achievements endpoint
+    * new character appearance endpoint
+    * new character equipment endpoint
+    * new character media endpoint
+    * new character profile endpoint
+    * new character pvp endpoints
+    * new character specialization endpoint
+    * new character statistics endpoint
+    * new character titles endpoint
+* Changes in community endpoints:
+    * new `get_oauth_profile` endpoint

MANIFEST.in

@@ -9,4 +9,5 @@ include pytest.ini
 recursive-include docs *
 recursive-exclude * *.py[co]
 recursive-exclude * *.DS_Store
-recursive-exclude * __pycache__
+recursive-exclude * *,cover
+recursive-exclude * __pycache__

Makefile

@@ -1,22 +1,26 @@
 .PHONY: tests devinstall docs clean clean_build build test_publish publish
 
 
-tests:
-	pytest -s -v tests
-
 devinstall:
 	pip install -e .
 	pip install -e .[tests]
 	pip install -e .[docs]
 
-docs: clean
-	sphinx-apidoc --force -o docs/modules/ wowapi
-	$(MAKE) -C docs clean
-	$(MAKE) -C docs html
+docs:
+	rm -rf docs
+	mkdir docs
+	pydocmd simple wowapi++ wowapi.api++ wowapi.mixins.community++ wowapi.mixins.game_data++ wowapi.mixins.profile++ > docs/api.md
 
-build:
+clean:
 	rm -rf dist
 	rm -rf build
+	rm -rf cov_html
+	rm -rf python_wowapi.egg-info
+	rm -rf .coverage
+	rm -rf docs
+
+build:
+	make clean
 	python setup.py sdist bdist_wheel
 
 test_publish:

README.md

@@ -7,70 +7,54 @@
 
 
 
-Python-wowapi is a client library for interacting with the World of Warcraft
-Community and Game Data API.
+Python-wowapi is a client library for interacting with the World of Warcraft endpoins of the [Blizzard API](https://develop.battle.net/documentation/guides/getting-started)
 
-To interact with this library, you need to first get a client-id and client secret by registering [here](https://develop.battle.net/access)
+Python-wowapi includes support for the following WoW API's:
+* Community API
+* Game data API
+* Character Profile API
+
+To interact with this library, you need to first get a client-id and client secret by [registering](https://develop.battle.net/access) your application.
 
 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/)
+* [Official API documentation](https://develop.battle.net/documentation)
+* [Official API Forum](https://us.forums.blizzard.com/en/blizzard/c/api-discussion)
+
+## API Docs
 
-API documentation can be found at [python-wowapi.readthedocs.org](https://python-wowapi.readthedocs.org). Examples and installation instructions are documented here.
+For examples and all available endpoints, visit the [API Documentation](docs/api.md)
 
 ## Installing
 
 ```bash
 pip install python-wowapi
 ```
 
-## API instance
-
-```python
-import os
-
-from wowapi import WowApi
-
-api = WowApi(os.environ['WOW_CLIENT_ID'], os.environ['WOW_CLIENT_SECRET'])
-```
-
-## Community API example
-
-```python
-api.get_auctions('eu', 'silvermoon', locale='de_DE')
-```
-
+## WoW Classic API support
 
-## Game Data API examples
+According to this [Forum post](https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-classic-api-endpoints/346), Blizzard is adding support for some game data API's.
 
+In order to use these endpoints, you need to provide the classic namespace:
 
-### Get token price
 ```python
-api.get_token('eu', namespace='dynamic-eu', locale='de_DE')
+api.get_item_class_index('us', 'static-classic-us')
 ```
 
-### Get class specializations and detail specialization resource
-```python
-data = api.get_playable_specializations('us', namespace='static-us')
+## Development & Testing
 
-spec_id = data['character_specializations'][0]['id']
-specialization = api.get_playable_specialization('us', namespace='static-us', spec_id=spec_id)
+```bash
+make devinstall
+pytest
 ```
 
-### 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.
+Alternatively you can also run the full [drone.io](https://drone.io) pipeline [locally](https://docs.drone.io/cli/install/) or [remote](https://cloud.drone.io/lockwooddev/python-wowapi/)
 
-```python
-api.get_data_resource('https://eu.api.blizzard.com/data/wow/connected-realm/509?namespace=dynamic-eu', region='eu')
+```bash
+drone exec
 ```
 
-
-## Development & Testing
+To build the docs:
 
 ```bash
-pip install -e .
-pip install -e .[tests]
-pytest
+make docs
 ```