Skip to main content

Snooker Data API

Project description

Snooker :black_circle: :red_circle: :white_circle:

PyPI version Build Status License


snooker is a Python package providing thin wrapper over publicly available API for retrieving Snooker statistics.

What is Snooker ?

Following Wikipedia's definition:

Snooker (pronounced UK: /ˈsnuːkər/, US: /ˈsnʊkər/)[2][3] is a cue sport that was first played by British Army officers stationed in India in the second half of the 19th century. It is played on a rectangular table covered with a green cloth (or "baize"), with six pockets: one at each corner and one in the middle of each long side. Using a cue stick, the players[a] take turns to strike the white "cue ball" to pot the other twenty-one snooker balls in the correct sequence, accumulating points for each pot. An individual frame of snooker is won by the player who has scored the most points by the end of the frame. A snooker match ends with one of the players having won a predetermined number of frames, thus winning the match.

Getting started

Installation

pip install snooker

Api Usage

Snooker Org

from snooker.api import SnookerOrgApi

client = SnookerOrgApi()

player = client.player(5)

print(player)
Custom headers

Following snooker.org API documentation:

If you plan to collect data automatically please contact us so we can agree on what you should put in the header. E.g. "X-Requested-By": "PetersAndroidApp".

To achieve this, simply pass appropriate headers when instantiating the client:

from snooker.api import SnookerOrgApi

client = SnookerOrgApi(headers={'X-Requested-By': 'mgorsk1'})

JSON Data

Returned data is serialized using Python native functionality called dataclasses. If you need to convert it to JSON, simply do:

from snooker.api import SnookerOrgApi

client = SnookerOrgApi()

player = client.player(5).to_dict()

print(player)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snooker-0.5.0.tar.gz (9.8 kB view hashes)

Uploaded source

Built Distribution

snooker-0.5.0-py3-none-any.whl (11.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page