.. image:: https://i.imgur.com/5uUkTrn.png
:alt: Brawl Stats
Brawl Stats
===========
.. image:: https://img.shields.io/pypi/v/brawlstats.svg
:target: https://pypi.org/project/brawlstats/
:alt: PyPi
.. image:: https://github.com/SharpBit/brawlstats/actions/workflows/tests.yml/badge.svg
:target: https://github.com/SharpBit/brawlstats/actions/workflows/tests.yml
:alt: GitHub Actions Tests
.. image:: https://img.shields.io/pypi/pyversions/brawlstats.svg
:target: https://pypi.org/project/brawlstats/
:alt: Supported Versions
.. image:: https://img.shields.io/github/license/SharpBit/brawlstats.svg
:target: https://github.com/SharpBit/brawlstats/blob/master/LICENSE
:alt: MIT License
.. image:: https://readthedocs.org/projects/brawlstats/badge/?version=stable
:target: https://brawlstats.readthedocs.io/en/stable/?badge=stable
:alt: Documentation Status
- BrawlStats is a sync and async Python API wrapper to fetch statistics from the official Brawl Stars API.
- Python 3.9 or later is required.
Features
~~~~~~~~
- Easy to use with an object oriented design.
- Use the same client for sync and async usage.
- Get a player profile and battlelog.
- Get a club and its members.
- Get the top 200 rankings for players, clubs, or a specific brawler.
- Get information about all the brawlers in the game.
- Get information about the current event rotation!
Installation
~~~~~~~~~~~~
Install the latest stable build:
::
pip install brawlstats
Install the development build:
::
pip install git+https://github.com/SharpBit/brawlstats@development
Documentation
~~~~~~~~~~~~~
Documentation is being hosted on `Read the Docs`_.
Examples
~~~~~~~~
Examples are in the `examples folder`_.
- ``sync.py`` shows you basic sync usage
- ``async.py`` shows you basic async usage
- ``discord_cog.py`` shows an example Discord Bot cog using `discord.py`_
Misc
~~~~
- If you are currently using this wrapper, please star this repository :)
- If you come across an issue in the wrapper, please `create an issue`_.
- If you need an API key, visit https://developer.brawlstars.com
Contributing
~~~~~~~~~~~~
Special thanks to this project's contributors ❤️
- `erickang21`_
- `fourjr`_
- `golbu`_
- `kjkui`_
- `kyb3r`_
- `Papiersnipper`_
- `OrangutanGaming`_
- `Stitch`_
If you want to contribute, whether it be a bug fix or new feature, make sure to follow the `contributing guidelines`_.
This project is no longer actively maintained. No new features will be added, only bugfixes and security fixes will be accepted.
.. _create an issue: https://github.com/SharpBit/brawlstats/issues
.. _Read the Docs: https://brawlstats.readthedocs.io/en/stable/
.. _examples folder: https://github.com/SharpBit/brawlstats/tree/master/examples
.. _discord.py: https://github.com/rapptz/discord.py
.. _contributing guidelines: https://github.com/SharpBit/brawlstats/blob/master/CONTRIBUTING.md
.. _erickang21: https://github.com/erickang21
.. _fourjr: https://github.com/fourjr
.. _OrangutanGaming: https://github.com/OrangutanGaming
.. _Stitch: https://github.com/Soumil07
.. _kjkui: https://github.com/kjkui
.. _kyb3r: https://github.com/kyb3r
.. _Papiersnipper: https://github.com/robinmahieu
.. _golbu: https://github.com/0dminnimda
Raw data
{
"_id": null,
"home_page": "https://github.com/SharpBit/brawlstats",
"name": "brawlstats",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": null,
"keywords": "brawl stars, brawl stats, brawlstats, supercell, python, sync, async, python wrapper, api wrapper, python api wrapper, python 3.9, python 3.10, python 3.11, python 3.12",
"author": "SharpBit",
"author_email": "sharpbit3618@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/38/54/347b5aa79f50885b77ee49cff8bfe9a9a5fcfdcb56ee8621ec9a4b656375/brawlstats-4.2.0.tar.gz",
"platform": null,
"description": ".. image:: https://i.imgur.com/5uUkTrn.png\r\n :alt: Brawl Stats\r\n\r\nBrawl Stats\r\n===========\r\n\r\n.. image:: https://img.shields.io/pypi/v/brawlstats.svg\r\n :target: https://pypi.org/project/brawlstats/\r\n :alt: PyPi\r\n\r\n.. image:: https://github.com/SharpBit/brawlstats/actions/workflows/tests.yml/badge.svg\r\n :target: https://github.com/SharpBit/brawlstats/actions/workflows/tests.yml\r\n :alt: GitHub Actions Tests\r\n\r\n.. image:: https://img.shields.io/pypi/pyversions/brawlstats.svg\r\n :target: https://pypi.org/project/brawlstats/\r\n :alt: Supported Versions\r\n\r\n.. image:: https://img.shields.io/github/license/SharpBit/brawlstats.svg\r\n :target: https://github.com/SharpBit/brawlstats/blob/master/LICENSE\r\n :alt: MIT License\r\n\r\n.. image:: https://readthedocs.org/projects/brawlstats/badge/?version=stable\r\n :target: https://brawlstats.readthedocs.io/en/stable/?badge=stable\r\n :alt: Documentation Status\r\n\r\n- BrawlStats is a sync and async Python API wrapper to fetch statistics from the official Brawl Stars API.\r\n- Python 3.9 or later is required.\r\n\r\nFeatures\r\n~~~~~~~~\r\n\r\n- Easy to use with an object oriented design.\r\n- Use the same client for sync and async usage.\r\n- Get a player profile and battlelog.\r\n- Get a club and its members.\r\n- Get the top 200 rankings for players, clubs, or a specific brawler.\r\n- Get information about all the brawlers in the game.\r\n- Get information about the current event rotation!\r\n\r\nInstallation\r\n~~~~~~~~~~~~\r\n\r\nInstall the latest stable build:\r\n\r\n::\r\n\r\n pip install brawlstats\r\n\r\nInstall the development build:\r\n\r\n::\r\n\r\n pip install git+https://github.com/SharpBit/brawlstats@development\r\n\r\nDocumentation\r\n~~~~~~~~~~~~~\r\n\r\nDocumentation is being hosted on `Read the Docs`_.\r\n\r\nExamples\r\n~~~~~~~~\r\nExamples are in the `examples folder`_.\r\n\r\n- ``sync.py`` shows you basic sync usage\r\n- ``async.py`` shows you basic async usage\r\n- ``discord_cog.py`` shows an example Discord Bot cog using `discord.py`_\r\n\r\nMisc\r\n~~~~\r\n\r\n- If you are currently using this wrapper, please star this repository :)\r\n- If you come across an issue in the wrapper, please `create an issue`_.\r\n- If you need an API key, visit https://developer.brawlstars.com\r\n\r\nContributing\r\n~~~~~~~~~~~~\r\nSpecial thanks to this project's contributors \u2764\ufe0f\r\n\r\n- `erickang21`_\r\n- `fourjr`_\r\n- `golbu`_\r\n- `kjkui`_\r\n- `kyb3r`_\r\n- `Papiersnipper`_\r\n- `OrangutanGaming`_\r\n- `Stitch`_\r\n\r\nIf you want to contribute, whether it be a bug fix or new feature, make sure to follow the `contributing guidelines`_.\r\nThis project is no longer actively maintained. No new features will be added, only bugfixes and security fixes will be accepted.\r\n\r\n.. _create an issue: https://github.com/SharpBit/brawlstats/issues\r\n.. _Read the Docs: https://brawlstats.readthedocs.io/en/stable/\r\n.. _examples folder: https://github.com/SharpBit/brawlstats/tree/master/examples\r\n.. _discord.py: https://github.com/rapptz/discord.py\r\n.. _contributing guidelines: https://github.com/SharpBit/brawlstats/blob/master/CONTRIBUTING.md\r\n\r\n.. _erickang21: https://github.com/erickang21\r\n.. _fourjr: https://github.com/fourjr\r\n.. _OrangutanGaming: https://github.com/OrangutanGaming\r\n.. _Stitch: https://github.com/Soumil07\r\n.. _kjkui: https://github.com/kjkui\r\n.. _kyb3r: https://github.com/kyb3r\r\n.. _Papiersnipper: https://github.com/robinmahieu\r\n.. _golbu: https://github.com/0dminnimda\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "BrawlStats is an easy-to-use sync and async Python API wrapperto fetch statistics from the official Brawl Stars API",
"version": "4.2.0",
"project_urls": {
"Documentation": "https://brawlstats.readthedocs.io/en/stable",
"Homepage": "https://github.com/SharpBit/brawlstats",
"Issue Tracker": "https://github.com/SharpBit/brawlstats/issues",
"Source Code": "https://github.com/SharpBit/brawlstats"
},
"split_keywords": [
"brawl stars",
" brawl stats",
" brawlstats",
" supercell",
" python",
" sync",
" async",
" python wrapper",
" api wrapper",
" python api wrapper",
" python 3.9",
" python 3.10",
" python 3.11",
" python 3.12"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3854347b5aa79f50885b77ee49cff8bfe9a9a5fcfdcb56ee8621ec9a4b656375",
"md5": "9b4d094d04d0cbc22bcb98cdb401cd46",
"sha256": "dd9be2864cd780b984d153e4db3c060414b1f324eb4e5505cd801321111b74b5"
},
"downloads": -1,
"filename": "brawlstats-4.2.0.tar.gz",
"has_sig": false,
"md5_digest": "9b4d094d04d0cbc22bcb98cdb401cd46",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 12299,
"upload_time": "2024-10-08T06:55:32",
"upload_time_iso_8601": "2024-10-08T06:55:32.676129Z",
"url": "https://files.pythonhosted.org/packages/38/54/347b5aa79f50885b77ee49cff8bfe9a9a5fcfdcb56ee8621ec9a4b656375/brawlstats-4.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-08 06:55:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SharpBit",
"github_project": "brawlstats",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "aiohttp",
"specs": [
[
">=",
"3.6.0"
]
]
},
{
"name": "requests",
"specs": []
},
{
"name": "python-box",
"specs": []
},
{
"name": "cachetools",
"specs": [
[
">=",
"3.1.0"
]
]
}
],
"tox": true,
"lcname": "brawlstats"
}
JSON
