PUBG JSON API wrapper and playback visualizer.
Project description
Chicken Dinner
==============
Python PUBG JSON API Wrapper and (optional) playback visualizer.
Sample
------
.. raw:: html
:file: match.html
Installation
------------
To install chicken-dinner, use pip. This will install the core dependencies
(``requests`` library) which provide functionality to the API wrapper classes.
.. code-block:: bash
pip install chicken-dinner
To use the playback visualizations you will need to install the library with
extra dependencies for plotting (``matplotlib`` and ``pillow``).
For this you can also use pip:
.. code-block:: bash
pip install chicken-dinner[visual]
To generate the animations you will also need ``ffmpeg`` installed on your
machine. On Max OSX you can install ``ffmpeg`` using brew.
.. code-block:: bash
brew install ffmpeg
You can install ffmpeg on other systems from `here <https://www.ffmpeg.org/download.html>`_.
Usage
-----
Working with the low-level API class.
.. code-block:: python
from chicken_dinner.pubgapi import PUBGCore
api_key = "your_api_key"
pubgcore = PUBGCore(api_key, "pc-na")
shroud = pubgcore.players("player_names", "shroud")
print(shroud)
# {'data': [{'type': 'player', 'id': 'account.d50f...
Working with the high-level API class.
.. code-block:: python
from chicken_dinner.pubgapi import PUBG
api_key = "your_api_key"
pubg = PUBG(api_key, "pc-na")
shroud = pubg.players_from_names("shroud")[0]
shroud_season = shroud.get_current_season()
squad_fpp_stats = shroud_season.game_mode_stats("squad", "fpp")
print(squad_fpp_stats)
# {'assists': 136, 'boosts': 313, 'dbnos': 550, 'daily_kills':...
Visualizing telemetry data
.. code-block:: python
from chicken_dinner.pubgapi import PUBG
api_key = "your_api_key"
pubg = PUBG(api_key, "pc-na")
shroud = pubg.players_from_names("shroud")[0]
recent_match_id = shroud.match_ids[0]
recent_match = pubg.match(recent_match_id)
recent_match_telemetry = recent_match.get_telemetry()
recent_match_telemetry.create_playback_animation("recent_match.html")
See the `documentation <http://chicken-dinner.readthedocs.io>`_ for more
details.
==============
Python PUBG JSON API Wrapper and (optional) playback visualizer.
Sample
------
.. raw:: html
:file: match.html
Installation
------------
To install chicken-dinner, use pip. This will install the core dependencies
(``requests`` library) which provide functionality to the API wrapper classes.
.. code-block:: bash
pip install chicken-dinner
To use the playback visualizations you will need to install the library with
extra dependencies for plotting (``matplotlib`` and ``pillow``).
For this you can also use pip:
.. code-block:: bash
pip install chicken-dinner[visual]
To generate the animations you will also need ``ffmpeg`` installed on your
machine. On Max OSX you can install ``ffmpeg`` using brew.
.. code-block:: bash
brew install ffmpeg
You can install ffmpeg on other systems from `here <https://www.ffmpeg.org/download.html>`_.
Usage
-----
Working with the low-level API class.
.. code-block:: python
from chicken_dinner.pubgapi import PUBGCore
api_key = "your_api_key"
pubgcore = PUBGCore(api_key, "pc-na")
shroud = pubgcore.players("player_names", "shroud")
print(shroud)
# {'data': [{'type': 'player', 'id': 'account.d50f...
Working with the high-level API class.
.. code-block:: python
from chicken_dinner.pubgapi import PUBG
api_key = "your_api_key"
pubg = PUBG(api_key, "pc-na")
shroud = pubg.players_from_names("shroud")[0]
shroud_season = shroud.get_current_season()
squad_fpp_stats = shroud_season.game_mode_stats("squad", "fpp")
print(squad_fpp_stats)
# {'assists': 136, 'boosts': 313, 'dbnos': 550, 'daily_kills':...
Visualizing telemetry data
.. code-block:: python
from chicken_dinner.pubgapi import PUBG
api_key = "your_api_key"
pubg = PUBG(api_key, "pc-na")
shroud = pubg.players_from_names("shroud")[0]
recent_match_id = shroud.match_ids[0]
recent_match = pubg.match(recent_match_id)
recent_match_telemetry = recent_match.get_telemetry()
recent_match_telemetry.create_playback_animation("recent_match.html")
See the `documentation <http://chicken-dinner.readthedocs.io>`_ for more
details.
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.
Source Distribution
chicken_dinner-0.1.0.tar.gz
(1.1 MB
view hashes)
Built Distribution
Close
Hashes for chicken_dinner-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 450873b3d13941ac4704034609e1181e703cfbb6bd44aabe10c147440a8b289d |
|
MD5 | d7a4f82afae4722f16e8cdc6bb5c9d2f |
|
BLAKE2b-256 | b9a1a2140e5c7ca10db4077c089b60dfa0720bf5814f14258da0aa7121d4fa15 |