Final fixes and version bump to v0.2.0

Author: mathsman5133

README.rst

@@ -36,7 +36,7 @@ Quick Example
     import coc
     import asyncio
 
-    client = coc.Client('email', 'password')
+    client = coc.login('email', 'password')
 
     async def get_some_player(tag):
         player = await client.get_player(tag)

coc/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-__version__ = '0.2.0a'
+__version__ = '0.2.0'
 
 from .clans import (
     Clan,

coc/client.py

@@ -1404,7 +1404,7 @@ def run_forever(self):
 
         Roughly equivilant to:
 
-        ..code-block:: python3
+        .. code-block:: python3
 
             try:
                 client.loop.run_forever()
@@ -1515,6 +1515,7 @@ def start_updates(self, event_type='all'):
         """Starts an, or all, events.
 
         .. note::
+
             This method **must** be called before any events are run.
 
         The lookup for event_name is as follows:
@@ -1563,13 +1564,12 @@ def start_updates(self, event_type='all'):
 
         Example
         --------
-        ..code-block:: python3
+        .. code-block:: python3
 
             client.start_updates('clan')
             # or, for all events:
             client.start_updates('all')
 
-
         """
         lookup = {
             'clan': [self._clan_update_event, [cache_current_wars]],
@@ -1600,7 +1600,7 @@ def stop_updates(self, event_type='all'):
 
         Example
         --------
-        ..code-block:: python3
+        .. code-block:: python3
 
             client.stop_updates('clan')
             # or, for all events:

coc/utils.py

@@ -60,6 +60,7 @@ def predicate(elem):
 def from_timestamp(timestamp):
     return datetime.strptime(timestamp, '%Y%m%dT%H%M%S.000Z')
 
+
 def correct_tag(tag, prefix='#'):
     """Attempts to correct malformed Clash of Clans tags
     to match how they are formatted in game

docs/changelog.rst

@@ -6,6 +6,73 @@ Changelog
 This page keeps a fairly detailed, human readable version
 of what has changed, and whats new for each version of the lib.
 
+v0.2.0
+--------
+EventsClient
+~~~~~~~~~~~~~~
+- :class:`EventsClient`
+- Provides all functionality of :class:`Client`, as well as an events-like system.
+- It will constantly request to the API every X seconds and detect indifferences between the cached and new results
+  returned by API. It will then send out 'events', basically calling functions that you must register, to tell you that
+  these things have happened
+- Split into 3 categories: player, clan and war
+
+Player
+
+    - All events regarding anything in the API that can change.
+    - E.g, name, troop levels (and unlocking), spells, heroes, donations, trophies etc.
+
+Clans
+
+    - All events regarding anything in the API that can change.
+    - E.g. description, type (invite only etc.), ranks, donations etc. of members, levelups.
+
+Wars
+
+    - All events regarding anything in the API that can change.
+    - E.g. new war attack, war state change
+
+- You must register the funtions events will call with :meth:`EventsClient.add_events`
+- You must 'subscribe' any clans, players or (clans in) wars you want to get with :meth:`EventsClient.add_clan_updates`,
+  :meth:`EventsClient.add_player_update`, :meth:`EventsClient.add_war_update`.
+
+- This can be a script that you run and will continue to run forever, calling your functions as events come through,
+  it doesn't have to be integrated into a bot. To ease this use-case, :meth:`EventsClient.run_forever` is handy.
+
+Other Importants
+~~~~~~~~~~~~~~~~~
+- Cache has had another overhaul about how it works, is called and default operational use.
+
+- From above, ``default_cache`` is a kwarg, and method of :class:`Client`. It defaults to the inbuilt method,
+  however you can pass your own function into this.
+
+- Logging in: the new recommended way of logging in is via ``client = coc.login(email, pass, **kwargs)`` with ``client``
+  being one of these kwargs: pass in either :class:`EventsClient` or :class:`Client` to use respective clients. This
+  makes both Client class creation and HTTP logging in easy through one function. Any additional kwargs passed will become
+  kwargs for the client you are using.
+
+- ``CurrentWar`` has been renamed, revamped and relooked at. A regular clan-war is now a :class:`ClanWar`, with
+  ``WarIterator`` being renamed to ``ClanWarIterator``. ``LeagueWarIterator`` and ``CurrentWarIterator`` now exist,
+  Current wars being a mix of either clan or league wars.
+
+- :meth:`Client.get_clan_war` now retrieves the current :class:`ClanWar`
+
+- :meth:`Client.get_current_war` now attempts to retrieve the current :class:`ClanWar`, and if in the ``notInWar`` state,
+  will attempt to search for a leauge war and return that, if found. This makes getting league wars and
+  clan wars from the API much easier than before.
+- :attr:`ClanWar.type` and :attr:`LeagueWar.type` now return a string of either ``cwl, friendly, random`` - which war type it is.
+- :attr:`Timestamp.time` has been renamed to :attr:`Timestamp.raw_time`, and replaced with :attr:`Timestamp.utc_timestamp` (now called :attr:`Timestamp.time`)
+- Add :attr:`ClanWar.status` returns a string ``winning, losing, tied, won, lost, tie`` depending on stars + destruction.
+
+BugFixes
+~~~~~~~~~
+- Lots of little ones with cache
+- Performance upgrades with use of ``__slots__`` on more classes
+- Trying to iterate over used up iterators
+- Only log requests throttled as debug
+- Trying to pop a cache item failed
+- Few little regex and other bugs in cache.
+
 v0.1.3
 --------
 BugFixes

setup.py

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