Skip to main content

Python client for xmlstats API

Project description

xmlstats-py

Build Status

A python module for interacting with the xmlstats API

This module aims to closely mirror the methods provided by the xmlstats API in terms of parameters and output structure.

Installing

pip install xmlstats-py

Tested against Python 2.7, 3.2-3.6

Usage

Instantiate an XmlStats object using a valid access token and user agent, obtained from the xmlstats API.

stats = Xmlstats(access_token=MY_ACCESS_TOKEN, user_agent=MY_USER_AGENT)

This object exposes a number of methods (one for each API endpoint) that return a NamedTuple representation of the data provided by the API. The JSON response is processed with json.loads, and a custom object_hook is used to convert JSON objects into NamedTuples when they are encountered. This means fields can be accessed using dot notation.

Methods

Each method exposed by the Xmlstats class aims to mirror an the endpoint provided by the API. See the API documentation for a complete explanation of parameters and results.

API Endpoint Class Method
Events events
Roster roster
Standings standings
Teams teams
Team Schedule/Results team_results
NBA Box Score nba_box_score
NBA Draft nba_draft
NBA Daily Leaders nba_daily_leaders
NBA Team Stats nba_team_stats
MLB Box Score mlb_box_score
MLB Wild Card Standings mlb_wild_card_standings

Examples

Get Boxscores for a given date - yyyymmdd

stats = Xmlstats(access_token=MY_ACCESS_TOKEN, user_agent=MY_USER_AGENT)
events = stats.events(date="20141028", sport="nba")  # returns NamedTuple "Events" which mirrors data structure explained in API documentation, containing all NBA events on given date
event_ids = [event.event_id for event in events.event]
boxscores = [
        stats.nba_box_score(eid) for eid in event_ids
]

Changelog

1.0.1 (2017-08-09)

  • Fixed bugs in multiple NBA and MLB specific methods related to added parameters for method requests.

1.0.0 (2017-03-17)

  • Complete overhaul of the way data is returned and represented when using this library. Data is now returned as NamedTuples, rather than as either simple dictionaries/lists or “objectified” data as in previous versions.
  • Methods were reimplimented to match the endpoints of the xmlstats API. Each method exposed by the XmlStats class corresponds to a single endpoint provided by the API, and accepts the same arguments and parameters. This means users of this library can essentially refer to the already existing xmlstats API documentation.

0.1.5 (2015-11-03)

Fixes:

  • Fixed http_get bug that prevented including paramaters in the next request after a 429 response code from xlmstats server.

0.1.4 (2015-11-02)

Fixes:

  • Fixed format_result bug that prevented higher level API functions from working.

Testing:

  • Added some basic tests, with Travis CI integration

Documentation:

  • Added Travis CI embedded status image to READMEg

0.1.3 (2015-11-02)

Fixes:

  • Fixed bugs in http_get handling of 429 response from xmlstats API server. http_get now waits for the amount of time specified by server 429 response before continuing to make requests.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
Xmlstats_py-1.0.1-py2.py3-none-any.whl (7.2 kB) Copy SHA256 hash SHA256 Wheel py2.py3
Xmlstats-py-1.0.1.tar.gz (9.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page