Tidy up code, add changelog and bump version to v0.0.3

Author: mathsman5133

coc/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-__version__ = '0.0.1'
+__version__ = '0.0.3'
 
 from .client import Client
 from .dataclasses import (

coc/client.py

@@ -32,7 +32,6 @@
 
 from .http import HTTPClient
 from .dataclasses import *
-from .utils import to_json
 
 log = logging.getLogger(__name__)
 

coc/dataclasses.py

@@ -26,7 +26,6 @@
 """
 
 
-import itertools
 import pytz
 
 
@@ -1190,5 +1189,5 @@ def __init__(self, *, data):
         if self.clan:
             self.attack_count = self.clan._data.get('attacks')
             self.stars = self.clan._data.get('stars')
-            self.destruction = self.clan._data.get('destructionPercentag')
+            self.destruction = self.clan._data.get('destructionPercentage')
             self.clan_level = self.clan._data.get('clanLevel')

coc/http.py

@@ -305,11 +305,3 @@ async def get_data_from_url(self, url):
             else:
                 raise HTTPException(r, 'failed to get image')
 
-
-
-
-
-
-
-
-

coc/utils.py

@@ -14,32 +14,22 @@ def to_json(model):
         if isinstance(value, list):
             for i in value:
                 if not isinstance(i, (list, str, bool)):
-                    if attr not in dct.keys():
-                        dct[attr] = [to_json(i)]
-                    else:
-                        dct[attr].append(to_json(i))
+                    dct[attr] = [to_json(i)] if attr not in dct.keys() else dct[attr].append(to_json(i))
                     continue
-                if attr not in dct.keys():
-                    dct[attr] = [to_json(i)]
-                else:
-                    dct[attr].append(to_json(i))
+
+                dct[attr] = [to_json(i)] if attr not in dct.keys() else dct[attr].append(to_json(i))
+
             continue
 
         # if it is an object attribute
         if not isinstance(value, (list, str, bool)):
-            if attr not in dct.keys():
-                dct[attr] = [to_json(value)]
-            else:
-                dct[attr].append(to_json(value))
+            dct[attr] = [to_json(value)] if attr not in dct.keys() else dct[attr].append(to_json(value))
             continue
 
         # just a bool, string or int now so can safely add to dict
-        if attr not in dct.keys():
-            dct[attr] = [to_json(value)]
-        else:
-            dct[attr].append(to_json(value))
+        dct[attr] = [to_json(value)] if attr not in dct.keys() else dct[attr].append(to_json(value))
 
-    return json.dumps(dct, separators=(',', ':'), ensure_ascii=True)
+    return json.loads(dct, separators=(',', ':'), ensure_ascii=True)
 
 
 

docs/changelog.rst

@@ -0,0 +1,55 @@
+.. current-module:: coc
+.. _whats_new:
+
+Changelog
+===========
+This page keeps a fairly detailed, human readable version
+of what has changed, and whats new for each version of the lib.
+
+
+v0.0.3
+-------
+BugFixes
+~~~~~~~~~
+- Fix some problems comparing naive and aware timestamps in :class:`.Timestamp`
+- Add a private ``_data`` attribute to all data classes.
+This is the json as the API returns it. It makes ``json=True`` parameters in
+requests easy to handle.
+- Only cache complete clan results - ie. `search_clans` only returned a :class:`BasicClan`,
+so in order to add some cache consistency, cached clans now only contain :class:`SearchClan`.
+
+Important
+----------
+- New Class - :class:`.LeagueWarLogEntry` is similar to :class:`WarLog`, however it has it's own
+set of attributes to ensure it is easier to use and know which ones are present and not.
+- This new class is utilised in ``Client.get_warlog``, which returns a ``list`` of both
+``LeagueWarLogEntry`` and ``WarLog``, depending on the war.
+
+Documentation
+--------------
+- Utilise `sphinx_rtd_theme` for the RTD page
+- Add this changelog
+- Continue to fix typos and little errors as they are found.
+
+
+v0.0.2
+-------
+BugFixes
+~~~~~~~~~
+- Fix some attributes from inherited classes not being present
+- Fix some :exc:`AttributeError` from being thrown due to incomplete data from API
+- When a clan is not in war, :class:`.WarClan` will not be present.
+Some errors were being thrown due to incomplete data being given from API
+- Allow for text-only responses from API (ie. not json)
+
+
+Important Changes
+~~~~~~~~~~~~~~~~~~
+- Actually specify that the package coc needs to be installed when installing with pip
+- Fix incorrect spelling of both :class:`.Achievement` and :exc:`InvalidArgument`
+- Update the examples in the README to work (search_players is not a thing)
+
+
+v0.0.1
+-------
+Initial Commit!

docs/index.rst

@@ -14,6 +14,12 @@ API Reference
 
    api
 
+Changelog
+----------
+.. toctree::
+   :maxdepth: 2
+
+   changelog
 
 If you still can't find what you're looking for, try in one of the following pages:
 

setup.py

@@ -5,7 +5,7 @@
 with open(os.path.join(os.getcwd(), 'requirements.txt')) as f:
     requirements = f.read().splitlines()
 
-version = '0.0.2'
+version = '0.0.3'
 
 readme = ''
 with open('README.rst') as f: