Merge branch 'rewrite' into master

# Conflicts:
#	coc/__init__.py
#	coc/clans.py
#	coc/client.py
#	coc/enums.py
#	coc/events.py
#	coc/login.py
#	coc/miscmodels.py
#	coc/players.py
#	docs/miscellaneous/changelog.rst
#	examples/events.py
#	examples/war_logs.py
#	setup.py

Author: mathsman5133

.github/workflows/push-to-pypi.yml

@@ -0,0 +1,24 @@
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.github/workflows/tests.yml

@@ -0,0 +1,41 @@
+name: coc.py Workflows
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      # You can use PyPy versions in python-version.
+      # For example, pypy2 and pypy3
+      matrix:
+        python-version: [3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    # You can test your matrix by printing the current Python version
+    - name: Display Python version
+      run: python -c "import sys; print(sys.version)"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install discord.py==1.5.0
+        pip install -r requirements.txt
+    - name: Running examples as tests
+      env:
+        DEV_SITE_EMAIL: ${{ secrets.DEV_SITE_EMAIL }}
+        DEV_SITE_PASSWORD: ${{ secrets.DEV_SITE_PASSWORD }}
+        DISCORD_BOT_TOKEN: ${{ secrets.DISCORD_BOT_TOKEN }}
+        LINKS_API_USERNAME: ${{ secrets.LINKS_API_USERNAME }}
+        LINKS_API_PASSWORD: ${{ secrets.LINKS_API_PASSWORD }}
+        RUNNING_TESTS: true
+      run: |
+        python -m examples.discord_bot
+        python -m examples.discord_links
+        python -m examples.events
+        python -m examples.war_logs

.gitignore

@@ -102,3 +102,9 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+# creds
+examples/creds.py
+
+# vscode
+.vscode/

.pre-commit-config.yaml

@@ -1,7 +1,6 @@
 MIT License
 
-Copyright (c) 2019 mathsman5133
-
+Copyright (c) 2019-2020 mathsman5133
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights

.pylintrc

@@ -1,3 +1,5 @@
 include README.rst
 include LICENSE
-include requirements.txt
+include requirements.txt
+include coc/py.typed
+recursive-include coc *.pyi

.travis.yml

@@ -10,9 +10,6 @@ coc.py
 .. image:: https://img.shields.io/pypi/pyversions/discord.py.svg
    :target: https://pypi.python.org/pypi/coc.py
    :alt: PyPI supported Python versions
-.. image:: https://travis-ci.org/mathsman5133/coc.py.svg?branch=master
-    :target: https://travis-ci.org/mathsman5133/coc.py
-    :alt: Travis CI info
 
 
 Easy to use asynchronous Clash of Clans API wrapper in Python.
@@ -22,8 +19,7 @@ Key Features
 - Asynchronous code
 - Entire coverage of the official Clash of Clans API
 - Email/password login removes the stress of managing tokens
-- Optimised for speed and performance
-- Completely customisable cache
+- Optimised for speed, memory and performance
 
 Getting Started
 ================
@@ -55,36 +51,44 @@ This example will get a player with a certain tag, and search for 5 clans with a
     import asyncio
 
     client = coc.login('email', 'password')
-    loop = asyncio.get_event_loop()
 
-    player = loop.run_until_complete(client.get_player('tag'))
-    print(player.name)
+    async def main():
+        player = await client.get_player("tag")
+        print("{0.name} has {0.trophies} trophies!".format(player))
 
-    async def get_five_clans(name):
-        players = await client.search_clans(name=name, limit=5)
-        for n in players:
-            print(n, n.tag)
+        clans = await client.search_clans(name="Best Clan Ever", limit=5)
+        for clan in clans:
+            print("{0.name} ({0.tag}) has {0.member_count} members".format(clan))
 
-    if __name__ == '__main__':
-        loop.run_until_complete(get_five_clans('name'))
-        loop.run_until_complete(client.close())
+        try:
+            war = await client.get_current_war("#clantag")
+            print(f"{0.clan_tag} is currently in {0.state} state.".format(war))
+        except coc.PrivateWarLog:
+            print("Uh oh, they have a private war log!")
+
+    client.loop.run_until_complete(main())
 
 Basic Events Example
 ---------------------
-This script will run forever, printing to the terminal whenever someone joins the clan.
+This script will run forever, printing to the terminal
+whenever someone joins the clan or a member of the clan donates troops.
 
 .. code:: py
 
     import coc
-    import asyncio
 
     client = coc.login('email', 'password', client=coc.EventsClient)
 
     @client.event
-    async def on_clan_member_join(player, clan):
-        print('{0.name} ({0.tag}) just joined {1.name} ({1.tag})!'.format(player, clan))
+    @coc.ClanEvents.member_join(tags=["#clantag", "#clantag2"])
+    async def foo(player, clan):
+        print("{0.name} ({0.tag}) just joined {1.name} ({1.tag})!".format(player, clan))
 
-    client.add_clan_update('tag')
+    @client.event
+    @coc.ClanEvents.member_donations(tags=["#clantag", "#clantag2"])
+    async def bar(old_member, member):
+        troops_donated = member.donations - old_member.donations
+        print("{0} just donated {1} troops!".format(member.name, troops_donated))
 
     client.run_forever()
 
@@ -94,39 +98,19 @@ For more examples see the examples directory
 Contributing
 --------------
 Contributing is fantastic and much welcomed! If you have an issue, feel free to open an issue and start working on it.
-A few things to bear in mind:
-
-Installing the dev requirements:
-
-.. code:: sh
 
-    pip install -r dev-requirements.txt
-
-This will install all the dev requirements, such as pylint, sphinx and pre-commit. These are handy!
-
-**Setting up a git pre-commit hook**
-
-Code quality is important - the repo has automatic linting and CI implemented.
-
-In order to keep the git history
-clean, a pre-commit hook will automatically lint your code according to the repo's standard before you push.
-
-You can install this pre-commit hook with:
+If you wish to run, setup or work on documentation, you will need to install ``sphinx`` and a few related dependencies.
+These can be installed with:
 
 .. code:: sh
 
-    pre-commit install
-
-In your local terminal. The ``pre-commit`` module should have already been installed
-if you installed the dev-requirements
+    pip install .[docs]
 
-You can run all linting that will be run in CI with:
+If you wish to run linting, pylint, black and flake8 have been setup and can be run with:
 
 .. code:: sh
 
     python setup.py lint
-    // or
-    pre-commit run --all-files
 
 Links
 ------
@@ -136,9 +120,9 @@ Links
 
 Disclaimer
 -----------
-- This content is not affiliated with, endorsed, sponsored, or specifically
-  approved by Supercell and Supercell is not responsible for it.
-  For more information see `Supercell's Fan Content Policy: <https://www.supercell.com/fan-content-policy.>`_
+This content is not affiliated with, endorsed, sponsored, or specifically
+approved by Supercell and Supercell is not responsible for it.
+For more information see `Supercell's Fan Content Policy. <https://www.supercell.com/fan-content-policy.>`_
 
 
 

LICENSE

@@ -1,23 +1,36 @@
 """
-Clash of Clans API Wrapper
-~~~~~~~~~~~~~~~~~~~
+MIT License
 
-A basic wrapper for the Clash of Clans API.
+Copyright (c) 2019-2020 mathsman5133
 
-:copyright: (c) 2015-2019 mathsman5133
-:license: MIT, see LICENSE for more details.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
 """
-__version__ = "0.3.4"
 
-from .cache import Cache, CacheConfig, DefaultCache, MaxSizeCache, TimeToLiveCache
+__version__ = "1.0.0"
 
-from .clans import Clan, SearchClan, BasicClan, WarClan, LeagueClan
+from .abc import BasePlayer, BaseClan
+from .clans import RankedClan, Clan
 from .client import Client
-from .events import EventsClient
+from .events import PlayerEvents, ClanEvents, WarEvents, EventsClient, ClientEvents
 from .enums import (
-    CacheType,
     Role,
+    WarRound,
     ACHIEVEMENT_ORDER,
     BUILDER_TROOPS_ORDER,
     DARK_ELIXIR_SPELL_ORDER,
@@ -42,7 +55,7 @@
     PrivateWarLog,
 )
 from .login import login
-from .http import HTTPClient
+from .http import BasicThrottler, BatchThrottler, HTTPClient
 from .iterators import (
     ClanIterator,
     PlayerIterator,
@@ -53,8 +66,8 @@
 from .miscmodels import (
     Achievement,
     Badge,
-    EqualityComparable,
     Hero,
+    Icon,
     League,
     LegendStatistics,
     Location,
@@ -64,21 +77,10 @@
     Label,
     WarLeague,
 )
-from .players import (
-    Player,
-    BasicPlayer,
-    SearchPlayer,
-    LeaguePlayer,
-    LeagueRankedPlayer,
-    WarMember,
-)
-from .wars import (
-    BaseWar,
-    WarLog,
-    ClanWar,
-    WarAttack,
-    LeagueGroup,
-    LeagueWar,
-    LeagueWarLogEntry,
-)
+from .players import Player, ClanMember, RankedPlayer
+from .player_clan import PlayerClan
+from .war_clans import WarClan, ClanWarLeagueClan
+from .war_attack import WarAttack
+from .war_members import ClanWarLeagueClanMember, ClanWarMember
+from .wars import ClanWar, ClanWarLogEntry, ClanWarLeagueGroup
 from . import utils