battlefy.py

Name	battlefy.py JSON
Version	0.6.1 JSON
	download
home_page
Summary	A Python Library for Battlefy.com
upload_time	2024-01-23 21:34:14
maintainer
docs_url	None
author	Vincent Lee
requires_python	>=3.11,<4.0
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # WORK IN PROGRESS

This library is still a wip and is far from ready to be used. Feel free to use but expect breaking changes if you don't lock a version.

# Battlefy.py 
A Python Library for Battlefy.com

Battlefy.py is an asyncio library for accessing information off of Battlefy.com.

This library has been designed for use by IPL for Splatoon tournaments primarily. 

## Installation
```sh
pip install battlefy.py
```

## Usage

### Tournaments
```py
from battlefy import TournamentClient

client = TournamentClient(headers = {})

tour_id = "5d167f61ddd2f83f429dc858"
tournament = await client.get_tournament(tour_id)

print(tournament.name)
```
            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "battlefy.py",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Vincent Lee",
    "author_email": "vlee@vlee.me.uk",
    "download_url": "https://files.pythonhosted.org/packages/3f/d4/8acc3111dc72de3b9c56d9d78d4d814209e024f33fae0595aec6461b5646/battlefy_py-0.6.1.tar.gz",
    "platform": null,
    "description": "# WORK IN PROGRESS\n\nThis library is still a wip and is far from ready to be used. Feel free to use but expect breaking changes if you don't lock a version.\n\n# Battlefy.py \nA Python Library for Battlefy.com\n\nBattlefy.py is an asyncio library for accessing information off of Battlefy.com.\n\nThis library has been designed for use by IPL for Splatoon tournaments primarily. \n\n## Installation\n```sh\npip install battlefy.py\n```\n\n## Usage\n\n### Tournaments\n```py\nfrom battlefy import TournamentClient\n\nclient = TournamentClient(headers = {})\n\ntour_id = \"5d167f61ddd2f83f429dc858\"\ntournament = await client.get_tournament(tour_id)\n\nprint(tournament.name)\n```",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Python Library for Battlefy.com",
    "version": "0.6.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8f3f1112f6d2855b5ad51a78f9f28ac22045bfe90166c4f72f8c865e3ca09316",
                "md5": "b6596d85d9ea74450ab8528f90057552",
                "sha256": "bc92bbe7ae9519c52113284b43804761cd908473ab6c766466af1a77907c5058"
            },
            "downloads": -1,
            "filename": "battlefy_py-0.6.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b6596d85d9ea74450ab8528f90057552",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11,<4.0",
            "size": 17976,
            "upload_time": "2024-01-23T21:34:13",
            "upload_time_iso_8601": "2024-01-23T21:34:13.023996Z",
            "url": "https://files.pythonhosted.org/packages/8f/3f/1112f6d2855b5ad51a78f9f28ac22045bfe90166c4f72f8c865e3ca09316/battlefy_py-0.6.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3fd48acc3111dc72de3b9c56d9d78d4d814209e024f33fae0595aec6461b5646",
                "md5": "a6a1e5b0e27efbc247583ed66651b816",
                "sha256": "78cc01c85cf3a5966e4cdb63d78860591b8fb553f3b440c32ba09d637db318e9"
            },
            "downloads": -1,
            "filename": "battlefy_py-0.6.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a6a1e5b0e27efbc247583ed66651b816",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11,<4.0",
            "size": 14286,
            "upload_time": "2024-01-23T21:34:14",
            "upload_time_iso_8601": "2024-01-23T21:34:14.175463Z",
            "url": "https://files.pythonhosted.org/packages/3f/d4/8acc3111dc72de3b9c56d9d78d4d814209e024f33fae0595aec6461b5646/battlefy_py-0.6.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-23 21:34:14",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "battlefy.py"
}