Skip to main content

A cli application for real time cricket match notifications.

Project description

cricNotifier GitHub release (latest by date) GitHub GitHub last commit GitHub issues Build Status

A CLI based application for real time cricket score updates.

Features

  • Rich command line interface
  • Choose among multiple live matches
  • Cross platform notifications, works on Windows and Linux systems

Installation

Make sure you have python > 3.5 and pip installed, you can install it from here

For Linux systems, if you want to enable notifications, install dependencies for dbus-python as per specifications from your distro, e.g. for Ubuntu based distros, install following:

sudo apt-get -y install libglib2.0-dev libdbus-1-3 libdbus-1-dev

Install using pip

pip install cricNotifier

Running the Application

Run following command on your terminal

cricNotifier [argument]

Arguments:

commentary        Fetch commentary for last few overs.
info              Fetch info for a match.
list              List all available matches.
score             Fetch latest score for a match.
select            Select a match with an ID.

Examples

Get list of currently available matches

image

Select a match using ID

image

Get info about selected match

image

Alternatively you can pass an ID which will override the preserved ID using select (for current command only).

image

Get squads for the match

image

Get latest score

image

Get text commentary of the match

image

Contributing

This project welcomes contributions and suggestions. Please feel free to create a PR, report an issue or put up a feature request.

Build cricNotifier locally

Clone the Repository

git clone https://github.com/zweack/cricNotifier.git && cd cricNotifier

Install Dependencies

Install poetry for dependency management and run

poetry install

Alternatively, you can use pip

pip install -r requirements.txt

You are ready to roll!

License

cricNotifier is licensed under the MIT License.

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

cricnotifier-2.0.3.tar.gz (10.4 kB view hashes)

Uploaded Source

Built Distribution

cricnotifier-2.0.3-py3-none-any.whl (10.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page