python-espncricinfo

Python wrapper for the ESPNCricInfo JSON API

https://github.com/outside-edge/python-espncricinfo

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Python wrapper for the ESPNCricInfo JSON API

Basic Info
  • Host: GitHub
  • Owner: outside-edge
  • License: mit
  • Language: Python
  • Default Branch: master
  • Size: 66.4 KB
Statistics
  • Stars: 177
  • Watchers: 10
  • Forks: 73
  • Open Issues: 19
  • Releases: 3
Created almost 11 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License Citation

README.md

python-espncricinfo

A Python 3 client for ESPNCricinfo's match, summary and player information.

Description

The splendid espncricinfo.com site not only provides individual HTML pages of cricket matches, it also provides a JSON representation of data from each match. This Python library provides access to many of those JSON attributes as well as some helper functions. All you need is the match ID, which is the number at the end of a match page URL. See the Usage section for instructions, and see match.py for individual functions.

Disclaimer: This library is not intended for commercial use and neither it nor its creator has any affiliation with ESPNCricInfo. The LICENSE for this library applies only to the code, not to the data.

The current version of this library is 0.6.1. It is very much a work in progress, and bug reports and feature requests are welcomed.

Installation

python pip3 install python-espncricinfo

Usage

For a summary of live matches, create an instance of the Summary class:

```python

from espncricinfo.summary import Summary s = Summary() s.match_ids ['68079', '68209', '68081', '61375', '65429'] ```

For individual matches, pass in the ID as a string:

```python

from espncricinfo.match import Match m = Match('64148') m.description 'England [Marylebone Cricket Club] tour of Australia, Only ODI: Australia v England at Melbourne, Jan 5, 1971' ```

More recent matches will have more methods available to them (for older matches, those methods will return None). A full list of methods available to an instance of the Match class is in the code.

For player details, pass in the player ID (found in a player's URL - for example, Ajinkya Rahane is '277916'):

```python

from espncricinfo.player import Player p = Player('277916') p.name 'Ajinkya Rahane' ```

A full list of methods available to an instance of the Player class is in the code.

For series (or league) details, pass in the series ID (found in a match URL, for example, India's 2018 tour of England is '18018'):

```python

from espncricinfo.series import Series s = Series('18018') s.name 'India tour of Ireland and England 2018' ```

Tests

To run the tests:

shell python tests.py

Requirements

See requirements.txt

Owner

  • Name: Outside Edge
  • Login: outside-edge
  • Kind: organization

Citation (Citation.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Willis"
  given-names: "Derek" 
title: "python-espncricinfo: A Python 3 client for ESPNCricinfo's match, summary and player information."
version: 0.6.1
date-released: 2022-06-17
url: "https://github.com/outside-edge/python-espncricinfo"

GitHub Events

Total
  • Issues event: 2
  • Watch event: 30
  • Issue comment event: 11
  • Pull request event: 2
  • Fork event: 7
  • Create event: 1
Last Year
  • Issues event: 2
  • Watch event: 30
  • Issue comment event: 11
  • Pull request event: 2
  • Fork event: 7
  • Create event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 50
  • Total pull requests: 21
  • Average time to close issues: 8 months
  • Average time to close pull requests: 4 months
  • Total issue authors: 28
  • Total pull request authors: 14
  • Average comments per issue: 1.54
  • Average comments per pull request: 0.48
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 2
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
  • dwillis (13)
  • Ehsan1997 (9)
  • sbshah97 (2)
  • prasanna-sk (2)
  • Laurelborggreve (1)
  • hkakkar04 (1)
  • pranaykarwa (1)
  • hanishche (1)
  • OwenThomas (1)
  • abbygriffiths (1)
  • olibpool (1)
  • RavinderSingh13-git (1)
  • GG628 (1)
  • nayangarg (1)
  • tonmooy (1)
Pull Request Authors
  • JackMa222 (4)
  • scrambldchannel (3)
  • Ehsan1997 (2)
  • anveshs1 (2)
  • Akhil-Pothanapalli (2)
  • dependabot[bot] (2)
  • RNerd12 (2)
  • killuazoldyckreal (2)
  • ckola (2)
  • wally1002 (1)
  • soodoku (1)
  • sbshah97 (1)
  • snyk-bot (1)
  • BoredCyborg (1)
Top Labels
Issue Labels
enhancement (10) bug (5)
Pull Request Labels
dependencies (2)

Dependencies

requirements.txt pypi
  • beautifulsoup4 ==4.9.1
  • dateparser ==0.7.6
  • jdatetime ==3.6.2
  • python-dateutil ==2.8.1
  • python-espncricinfo ==0.4.1
  • pytz ==2020.1
  • pyyaml *
  • regex ==2020.6.8
  • requests >=2.20.0
  • six ==1.15.0
  • umalqurra ==0.2
  • wheel ==0.24.0
setup.py pypi
  • requests *
.github/workflows/python-publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish 27b31702a0e7fc50959f5ad993c78deac1bdfc29 composite
.github/workflows/test.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • actions/setup-python v1 composite