Skip to content
This repository has been archived by the owner on Sep 8, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mskian authored Sep 8, 2023
1 parent 1dd6984 commit 9749037
Showing 1 changed file with 1 addition and 113 deletions.
114 changes: 1 addition & 113 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,115 +1,3 @@
# Python Cricket Score

[![os-file-test](https://github.com/mskian/python-cricket-score/actions/workflows/os.yml/badge.svg)](https://github.com/mskian/python-cricket-score/actions/workflows/os.yml) [![get-score](https://github.com/mskian/python-cricket-score/actions/workflows/test.yml/badge.svg)](https://github.com/mskian/python-cricket-score/actions/workflows/test.yml)

Get Live Cricket Score on your Terminal - A Simple Live Score Data Scraper Created using Python.

> A Simple Python Script to Get Live Cricket Score on your Terminal and CMD
unofficial API Data Fetched from Cricbuzz.com **(This is for Education Purpose Only)**

This is an unofficial API and not Linked or Partnered with Any Brands/Company.

## How it Works? 🤔

We are just fetching and Scrape the data from Cricbuzz using Python `BeautifulSoup` Module It's kind of data scraping but we are not storing any data or link in our end.

Everything is scraped live and shown to end users in realtime.

I maily build the Live Cricket Score Python Script for my Galaxy watch 4 Automation via MacroDroid and KDE Connect.

I use **Kitty Terminal** for my Watch Automation

```sh
kitty --hold python3 $HOME/your-directory/python-criket-score/score.py
```

https://user-images.githubusercontent.com/10300271/227778482-391dcb78-93a9-4b8a-8230-3b75335f7ba5.mp4

## Requirements 📑

- Python 3
- Required Modules

## Installation 🍯

- Download or Clone Repo to your Server

```sh
git clone https://github.com/mskian/python-cricket-score.git
cd python-cricket-score
python -m pip install --upgrade pip
pip install -r requirements.txt
```

- Test the Script

```sh
## IPL SCore
python3 ipl.py

## Get Score the Match URL you Provided
python3 score.py
```

- it will automatically Generate a App folder on your OS Home directory Named as `python-cricket-score` with the `score.yaml` file
- Update Cricbuzz Live Match URL on `score.yaml` file

## JSON API

Free Python Cricket API - Scrape the data using `BeautifulSoup` and export a output via JSON using Flask micro web framework

Check - <https://github.com/mskian/python-cricket-score/tree/main/api>

## Contributing 🙌

Your PR's are Welcome

## Lint and Formatting

```sh
## Check Lint Errors
python3 -m pip install flake8
python3 -m flake8
```

```sh
## Auto Formatting the Code
pip install --upgrade autopep8
python3 -m autopep8 score.py ## Dry Run
python3 -m autopep8 -i score.py ## Format the Code

# Autofix
python3 -m autopep8 --select E1,E2,E3,E401,W2,W3 --ignore E226,E24,E26 --in-place --recursive --verbose .
```

```sh
## Check Lint Errors
pylint score.py
```

## Disclaimer 🗃

- This is not an Offical API from Cricbuzz - it's an Unofficial API
- This is for Education Purpose only - use at your own risk on Production Site

All Credits Goes to <https://www.cricbuzz.com/>

## My other Projects 🤓

| # | Project Name | Description |
|---|:------|-------------|
| 02 | [Live Cricket API PHP](https://github.com/mskian/cricket-api) | Free Cricket API - Live Cricket Score JSON API (PHP) - **Active Development** |
| 01 | [Live Cricket Score Static Site](https://github.com/mskian/livescore) | A Simple Scrape Method - Fetch the Live Cricket Score from `espncricinfo.com` using Nodejs and Cheerio.js - **Not Maintained** |
| 02 | [IPL Special](https://github.com/mskian/iplscore) | Cricket API for Get the Live IPL Cricket Score - **not maintained** |
| 03 | [Live IPL Score Update on Telegram](https://github.com/mskian/score-update) | Get Live IPL cricket Score on Telegram - **Partially maintained** |
| 04 | [Live Cricket Score Wordpress Plugin (JS Version)](https://github.com/mskian/hello-cricket) | Get Live Cricket Score on Wordpress site call API using Javascript Fetch API - **not maintained** |
| 05 | [Live Cricket Score Wordpress Plugin (Wp Remote URL)](https://github.com/mskian/san-cricket) | Get Live Cricket Score on Wordpress site call API using Wordpress HTTP Remote URL - **not maintained** |
| 06 | [PWA Web App](https://github.com/mskian/vue-cricket) | Real-time Live Cricket Score Web app + PWA Built using Nuxt.js - **not maintained** |
| 07 | [Cricket API Nodejs](https://github.com/mskian/cricket-api-nodejs) | JSON API Node.js Version - **Active Development** |
| 08 | [Cricket Score Widget](https://github.com/mskian/cricket-score-widget) | Live Cricket Score Javascript Widget Build using Svelte JS - **Partially maintained** |
| 09 | [Live Cricket Score CLI](https://github.com/mskian/cricket-cli) | Get Live Cricket Score Update on Terminal and CMD - **Active Development** |

## LICENSE 📕

MIT
This repo was Moved to - <https://github.com/sanwebinfo/python-cricket-score>

0 comments on commit 9749037

Please sign in to comment.