A python wrapper for the Clash of Clans API
Project description
coc.py
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.5 or higher is required
# Linux/macOS
python3 -m pip install -U coc.py
# Windows
py -3 -m pip install -U coc.py
# to install the development version:
python3 -m pip install -U git+https://github.com/mathsman5133/coc.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.
import coc
import asyncio
client = coc.login('email', 'password')
async def main():
player = await client.get_player("tag")
print("{0.name} has {0.trophies} trophies!".format(player))
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))
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 or a member of the clan donates troops.
import coc
client = coc.login('email', 'password', client=coc.EventsClient)
@client.event
@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.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()
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:
pip install .[docs]
If you wish to run linting, pylint, black and flake8 have been setup and can be run with:
python setup.py lint
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.