Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/201st-luka/pyclasher
This is a repository for my asynchronous ClashOfClans API wrapper written in Python. It is object oriented and provides an easy access to the requested data.
https://github.com/201st-luka/pyclasher
api api-client api-wrapper async asyncapi asynchronous asynchronous-programming asyncio clash-of-clans clash-of-clans-api clashofclans clashofclansapi python
Last synced: 24 days ago
JSON representation
This is a repository for my asynchronous ClashOfClans API wrapper written in Python. It is object oriented and provides an easy access to the requested data.
- Host: GitHub
- URL: https://github.com/201st-luka/pyclasher
- Owner: 201st-Luka
- License: mit
- Created: 2023-04-19T17:31:06.000Z (over 1 year ago)
- Default Branch: stable
- Last Pushed: 2024-09-22T10:19:11.000Z (3 months ago)
- Last Synced: 2024-11-14T21:40:09.774Z (about 1 month ago)
- Topics: api, api-client, api-wrapper, async, asyncapi, asynchronous, asynchronous-programming, asyncio, clash-of-clans, clash-of-clans-api, clashofclans, clashofclansapi, python
- Language: Python
- Homepage:
- Size: 2.65 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[![Discord][discord_shield]][discord_url] ![Last commit][last_commit_shield]
# PyClasher
PyClasher is the name of the asynchronous ClashOfClans API. It is
an object-oriented wrapper client that provides easy access to the
requested data.
---
I am planning to release the package on pypi.org after my exams. This is
probably in the first week of september.
The package is still in development and will be finished as short as
possible for me. When the package covers the whole ClashOfClans API, the
repository will be transformed into a python package and will be available for
everyone.
If you have any questions, feel free to join my discord server to ask your
question.
## Installation
The package is available on pypi.org. It is possible to install it via the
following command:
```bash
pip install pyclasher
```
## Documentation
The documentation of this project is available on
[PyClasher's GitHub pages][pyclasher_doc].
> **_NOTE:_** The documentation is not fully completed yet. It is still in
> progress.
---
## Features
- Asynchronous and parallel requesting
- Possibility to use multiple tokens and to login via email address and
password of the ClashOfClans developer portal
- Control over the number of requests per second and the number of used tokens
- Open source
- Type hinted
- Supports Python 3.8 -> 3.11
---
## Contributing
Feel free to contribute to the repository.
You can fork the repository and commit your changes in a pull request. Please
consider to check out the [Discord server][discord_url] if so.
For more information, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file
---
## Future
I'm planning to keep the API wrapper up to date and improve it as good as I can.
### Planned features
- more bulk requests
- events
### Planned utils
- documentation
- real example ([HeadhunterBot][headhunterbot_url] is in development)
### Planned code implementations (ToDo-list)
- attributes `king`, `queen`, `warden`, `royal_champion` for the
`Player.heroes` attribute
- events and an `EventClient`
---
If you find a bug, an error or want custom functionality, please tell me via
Discord or open an issue or start a discussion on the GitHub-repository.
---
##### Disclaimer
This material is unofficial and is not endorsed by Supercell. For more
information see Supercell's Fan Content Policy:
www.supercell.com/fan-content-policy.
[discord_shield]: https://img.shields.io/badge/Discord-blue?logo=discord&logoColor=white
[discord_url]: https://discord.gg/j2PAF9Wru8
[last_commit_shield]: https://img.shields.io/github/last-commit/201st-Luka/HeadhunterBot
[headhunterbot_url]: https://github.com/201st-Luka/HeadhunterBot
[pyclasher_doc]: https://201st-luka.github.io/PyClasher/