clashy.py 25.12.0__tar.gz

clashy_py-25.12.0/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 ClashKingInc
+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.

clashy_py-25.12.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include README.rst
+include LICENSE
+include requirements.txt
+include coc/static/*
+recursive-include coc *.pyi

clashy_py-25.12.0/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.4
+Name: clashy.py
+Version: 25.12.0
+Summary: A python wrapper for the Clash of Clans API
+Author: ClashKing
+Maintainer: MagicTheDev
+License: MIT
+Project-URL: documentation, https://clashy.clashk.ing/en/latest/
+Project-URL: repository, https://github.com/ClashKingInc/clashy.py
+Project-URL: changelog, https://clashy.clashk.ing/en/latest/miscellaneous/changelog.html
+Keywords: coc,clash of clans,clashy.py,clash api
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10.0
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: aiohttp
+Requires-Dist: orjson
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: sphinxcontrib_trio; extra == "docs"
+Requires-Dist: autodocsumm; extra == "docs"
+Dynamic: license-file
+
+clashy.py
+=========
+
+.. image:: https://discordapp.com/api/guilds/566451504332931073/embed.png
+    :target: https://discord.gg/Eaja7gJ
+    :alt: Discord Server Invite
+.. image:: https://img.shields.io/pypi/v/clashy.py.svg
+   :target: https://pypi.python.org/pypi/clashy.py
+   :alt: PyPI version info
+.. image:: https://img.shields.io/pypi/pyversions/clashy.py.svg
+   :target: https://pypi.python.org/pypi/clashy.py
+   :alt: PyPI supported Python versions
+
+
+Easy to use asynchronous Clash of Clans API wrapper in Python.
+
+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, memory and performance
+
+Getting Started
+================
+
+Installing
+-----------
+**Python 3.10 or higher is required**
+
+.. code:: sh
+
+    # Linux/macOS
+    python3 -m pip install -U clashy.py
+
+    # Windows
+    py -3 -m pip install -U clashy.py
+
+    # to install the development version:
+    python3 -m pip install -U git+https://github.com/ClashKingInc/clashy.py
+
+
+Quick Example
+--------------
+This is the basic usage of the library.
+This example will get a player with a certain tag, and search for 5 clans with a name.
+
+.. code:: py
+
+    import asyncio
+    import coc
+
+
+    async def main():
+        async with coc.Client() as coc_client:
+            try:
+                await coc_client.login("email", "password")
+            except coc.InvalidCredentials as error:
+                exit(error)
+
+            player = await coc_client.get_player("tag")
+            print(f"{player.name} has {player.trophies} trophies!")
+
+            clans = await coc_client.search_clans(name="best clan ever", limit=5)
+            for clan in clans:
+                print(f"{clan.name} ({clan.tag}) has {clan.member_count} members")
+
+            try:
+                war = await coc_client.get_current_war("#clantag")
+                print(f"{war.clan_tag} is currently in {war.state} state.")
+            except coc.privatewarlog:
+                print("uh oh, they have a private war log!")
+
+    if __name__ == "__main__":
+        try:
+            asyncio.run(main())
+        except KeyboardInterrupt:
+            pass
+
+Basic Events Example
+---------------------
+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 asyncio
+    import logging
+
+    import coc
+
+
+    @coc.ClanEvents.member_join()
+    async def foo(player, clan):
+        print(f"{player.name} ({player.tag}) just joined {clan.name} ({clan.tag})")
+
+
+    @coc.ClanEvents.member_donations()
+    async def bar(old_member, member):
+        troops_donated = member.donations - old_member.donations
+        print(f"{member.name} just donated {troops_donated} troops!")
+
+
+    async def main():
+        coc_client = coc.EVentsClient()
+        try:
+            await coc.login("email", "password")
+        except coc.InvalidCredentials as error:
+            exit(error)
+
+        # Register all the clans you want to monitor
+        list_of_clan_tags = ["tag1", "tag2", "tag3"]
+        coc_client.add_clan_updates(*list_of_clan_tags)
+
+        # Register the callbacks for each of the events you are monitoring
+        coc_client.add_events(
+            foo,
+            bar
+        )
+
+
+    if __name__ == "__main__":
+        logging.basicConfig(level=logging.INFO)
+        log = logging.getLogger()
+
+        loop = asyncio.get_event_loop()
+        try:
+            loop.run_until_complete(main())
+            loop.run_forever()
+        except KeyboardInterrupt:
+            pass
+
+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.
+
+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
+
+    pip install -r doc_requirements.txt
+    cd docs
+    make html
+
+If you wish to run linting, pylint, black and flake8 have been setup and can be run with:
+
+.. code:: sh
+
+    python setup.py lint
+
+Links
+------
+- `clashy.py Documentation <https://clashy.clashk.ing/en/latest/?>`_
+- `Official Clash of Clans API Page <https://developer.clashofclans.com/>`_
+- `Clash of Clans API Discord Server <https://discord.gg/Eaja7gJ>`_
+
+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.>`_
+
+
+

clashy_py-25.12.0/README.rst

@@ -0,0 +1,167 @@
+clashy.py
+=========
+
+.. image:: https://discordapp.com/api/guilds/566451504332931073/embed.png
+    :target: https://discord.gg/Eaja7gJ
+    :alt: Discord Server Invite
+.. image:: https://img.shields.io/pypi/v/clashy.py.svg
+   :target: https://pypi.python.org/pypi/clashy.py
+   :alt: PyPI version info
+.. image:: https://img.shields.io/pypi/pyversions/clashy.py.svg
+   :target: https://pypi.python.org/pypi/clashy.py
+   :alt: PyPI supported Python versions
+
+
+Easy to use asynchronous Clash of Clans API wrapper in Python.
+
+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, memory and performance
+
+Getting Started
+================
+
+Installing
+-----------
+**Python 3.10 or higher is required**
+
+.. code:: sh
+
+    # Linux/macOS
+    python3 -m pip install -U clashy.py
+
+    # Windows
+    py -3 -m pip install -U clashy.py
+
+    # to install the development version:
+    python3 -m pip install -U git+https://github.com/ClashKingInc/clashy.py
+
+
+Quick Example
+--------------
+This is the basic usage of the library.
+This example will get a player with a certain tag, and search for 5 clans with a name.
+
+.. code:: py
+
+    import asyncio
+    import coc
+
+
+    async def main():
+        async with coc.Client() as coc_client:
+            try:
+                await coc_client.login("email", "password")
+            except coc.InvalidCredentials as error:
+                exit(error)
+
+            player = await coc_client.get_player("tag")
+            print(f"{player.name} has {player.trophies} trophies!")
+
+            clans = await coc_client.search_clans(name="best clan ever", limit=5)
+            for clan in clans:
+                print(f"{clan.name} ({clan.tag}) has {clan.member_count} members")
+
+            try:
+                war = await coc_client.get_current_war("#clantag")
+                print(f"{war.clan_tag} is currently in {war.state} state.")
+            except coc.privatewarlog:
+                print("uh oh, they have a private war log!")
+
+    if __name__ == "__main__":
+        try:
+            asyncio.run(main())
+        except KeyboardInterrupt:
+            pass
+
+Basic Events Example
+---------------------
+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 asyncio
+    import logging
+
+    import coc
+
+
+    @coc.ClanEvents.member_join()
+    async def foo(player, clan):
+        print(f"{player.name} ({player.tag}) just joined {clan.name} ({clan.tag})")
+
+
+    @coc.ClanEvents.member_donations()
+    async def bar(old_member, member):
+        troops_donated = member.donations - old_member.donations
+        print(f"{member.name} just donated {troops_donated} troops!")
+
+
+    async def main():
+        coc_client = coc.EVentsClient()
+        try:
+            await coc.login("email", "password")
+        except coc.InvalidCredentials as error:
+            exit(error)
+
+        # Register all the clans you want to monitor
+        list_of_clan_tags = ["tag1", "tag2", "tag3"]
+        coc_client.add_clan_updates(*list_of_clan_tags)
+
+        # Register the callbacks for each of the events you are monitoring
+        coc_client.add_events(
+            foo,
+            bar
+        )
+
+
+    if __name__ == "__main__":
+        logging.basicConfig(level=logging.INFO)
+        log = logging.getLogger()
+
+        loop = asyncio.get_event_loop()
+        try:
+            loop.run_until_complete(main())
+            loop.run_forever()
+        except KeyboardInterrupt:
+            pass
+
+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.
+
+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
+
+    pip install -r doc_requirements.txt
+    cd docs
+    make html
+
+If you wish to run linting, pylint, black and flake8 have been setup and can be run with:
+
+.. code:: sh
+
+    python setup.py lint
+
+Links
+------
+- `clashy.py Documentation <https://clashy.clashk.ing/en/latest/?>`_
+- `Official Clash of Clans API Page <https://developer.clashofclans.com/>`_
+- `Clash of Clans API Discord Server <https://discord.gg/Eaja7gJ>`_
+
+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.>`_
+
+
+

clashy_py-25.12.0/clashy.py.egg-info/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.4
+Name: clashy.py
+Version: 25.12.0
+Summary: A python wrapper for the Clash of Clans API
+Author: ClashKing
+Maintainer: MagicTheDev
+License: MIT
+Project-URL: documentation, https://clashy.clashk.ing/en/latest/
+Project-URL: repository, https://github.com/ClashKingInc/clashy.py
+Project-URL: changelog, https://clashy.clashk.ing/en/latest/miscellaneous/changelog.html
+Keywords: coc,clash of clans,clashy.py,clash api
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10.0
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: aiohttp
+Requires-Dist: orjson
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: sphinxcontrib_trio; extra == "docs"
+Requires-Dist: autodocsumm; extra == "docs"
+Dynamic: license-file
+
+clashy.py
+=========
+
+.. image:: https://discordapp.com/api/guilds/566451504332931073/embed.png
+    :target: https://discord.gg/Eaja7gJ
+    :alt: Discord Server Invite
+.. image:: https://img.shields.io/pypi/v/clashy.py.svg
+   :target: https://pypi.python.org/pypi/clashy.py
+   :alt: PyPI version info
+.. image:: https://img.shields.io/pypi/pyversions/clashy.py.svg
+   :target: https://pypi.python.org/pypi/clashy.py
+   :alt: PyPI supported Python versions
+
+
+Easy to use asynchronous Clash of Clans API wrapper in Python.
+
+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, memory and performance
+
+Getting Started
+================
+
+Installing
+-----------
+**Python 3.10 or higher is required**
+
+.. code:: sh
+
+    # Linux/macOS
+    python3 -m pip install -U clashy.py
+
+    # Windows
+    py -3 -m pip install -U clashy.py
+
+    # to install the development version:
+    python3 -m pip install -U git+https://github.com/ClashKingInc/clashy.py
+
+
+Quick Example
+--------------
+This is the basic usage of the library.
+This example will get a player with a certain tag, and search for 5 clans with a name.
+
+.. code:: py
+
+    import asyncio
+    import coc
+
+
+    async def main():
+        async with coc.Client() as coc_client:
+            try:
+                await coc_client.login("email", "password")
+            except coc.InvalidCredentials as error:
+                exit(error)
+
+            player = await coc_client.get_player("tag")
+            print(f"{player.name} has {player.trophies} trophies!")
+
+            clans = await coc_client.search_clans(name="best clan ever", limit=5)
+            for clan in clans:
+                print(f"{clan.name} ({clan.tag}) has {clan.member_count} members")
+
+            try:
+                war = await coc_client.get_current_war("#clantag")
+                print(f"{war.clan_tag} is currently in {war.state} state.")
+            except coc.privatewarlog:
+                print("uh oh, they have a private war log!")
+
+    if __name__ == "__main__":
+        try:
+            asyncio.run(main())
+        except KeyboardInterrupt:
+            pass
+
+Basic Events Example
+---------------------
+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 asyncio
+    import logging
+
+    import coc
+
+
+    @coc.ClanEvents.member_join()
+    async def foo(player, clan):
+        print(f"{player.name} ({player.tag}) just joined {clan.name} ({clan.tag})")
+
+
+    @coc.ClanEvents.member_donations()
+    async def bar(old_member, member):
+        troops_donated = member.donations - old_member.donations
+        print(f"{member.name} just donated {troops_donated} troops!")
+
+
+    async def main():
+        coc_client = coc.EVentsClient()
+        try:
+            await coc.login("email", "password")
+        except coc.InvalidCredentials as error:
+            exit(error)
+
+        # Register all the clans you want to monitor
+        list_of_clan_tags = ["tag1", "tag2", "tag3"]
+        coc_client.add_clan_updates(*list_of_clan_tags)
+
+        # Register the callbacks for each of the events you are monitoring
+        coc_client.add_events(
+            foo,
+            bar
+        )
+
+
+    if __name__ == "__main__":
+        logging.basicConfig(level=logging.INFO)
+        log = logging.getLogger()
+
+        loop = asyncio.get_event_loop()
+        try:
+            loop.run_until_complete(main())
+            loop.run_forever()
+        except KeyboardInterrupt:
+            pass
+
+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.
+
+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
+
+    pip install -r doc_requirements.txt
+    cd docs
+    make html
+
+If you wish to run linting, pylint, black and flake8 have been setup and can be run with:
+
+.. code:: sh
+
+    python setup.py lint
+
+Links
+------
+- `clashy.py Documentation <https://clashy.clashk.ing/en/latest/?>`_
+- `Official Clash of Clans API Page <https://developer.clashofclans.com/>`_
+- `Clash of Clans API Discord Server <https://discord.gg/Eaja7gJ>`_
+
+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.>`_
+
+
+

clashy_py-25.12.0/clashy.py.egg-info/SOURCES.txt

@@ -0,0 +1,58 @@
+LICENSE
+MANIFEST.in
+README.rst
+pyproject.toml
+requirements.txt
+setup.py
+clashy.py.egg-info/PKG-INFO
+clashy.py.egg-info/SOURCES.txt
+clashy.py.egg-info/dependency_links.txt
+clashy.py.egg-info/requires.txt
+clashy.py.egg-info/top_level.txt
+coc/__init__.py
+coc/__main__.py
+coc/abc.py
+coc/buildings.py
+coc/characters.py
+coc/clans.py
+coc/client.py
+coc/constants.py
+coc/cosmetics.py
+coc/entry_logs.py
+coc/enums.py
+coc/errors.py
+coc/events.py
+coc/events.pyi
+coc/game_data.py
+coc/hero.py
+coc/http.py
+coc/iterators.py
+coc/miscmodels.py
+coc/player_clan.py
+coc/players.py
+coc/raid.py
+coc/spell.py
+coc/troop.py
+coc/utils.py
+coc/war_attack.py
+coc/war_clans.py
+coc/war_members.py
+coc/wars.py
+coc/ext/discordlinks/__init__.py
+coc/ext/triggers/__init__.py
+coc/ext/triggers/cron.py
+coc/ext/triggers/triggers.py
+coc/static/.DS_Store
+coc/static/static_data.json
+coc/static/translations.json
+coc/static/update_static.py
+tests/test_capitalraidseasons.py
+tests/test_clans.py
+tests/test_clash_meta.py
+tests/test_client.py
+tests/test_enums.py
+tests/test_login.py
+tests/test_miscmodels.py
+tests/test_players.py
+tests/test_troop_levels.py
+tests/test_wars.py

clashy_py-25.12.0/clashy.py.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

clashy_py-25.12.0/clashy.py.egg-info/requires.txt

@@ -0,0 +1,8 @@
+aiohttp
+orjson
+
+[docs]
+sphinx
+sphinx_rtd_theme
+sphinxcontrib_trio
+autodocsumm

clashy_py-25.12.0/clashy.py.egg-info/top_level.txt

@@ -0,0 +1 @@
+coc