[](https://www.python.org)
[](https://badge.fury.io/py/lgdash)
⚠️ This project is currently under active development and considered experimental (all 0.1.x releases).
# League Dashboard (lgdash)
Soccer/football at the command line. ⚽
Under the hood the app is calling the [football-data.org](https://www.football-data.org/) API, so an API token from that service is required. Register [here](https://www.football-data.org/pricing) to get one.
## Features
- live scores
- league standings
- league schedules
### Currently Supported Leagues
- Premier League (England 🏴)
- La Liga (Spain 🇪🇸)
- Serie A (Italy 🇮🇹)
- Bundesliga (Germany 🇩🇪)
- Ligue 1 (France 🇫🇷)
- UEFA Champions League (Europe)
## Quick Start
### Get API Token
If you don't have one, register for an API token [here](https://www.football-data.org/pricing).
Then add this line with your token to `.zshrc` or another appropriate startup file.
```
export FOOTBALLDATA_API_TOKEN=<token>
```
### Install
Available on PyPI.
`pip install lgdash`
### How to Use
#### Today's Slate of Matches
Live scores and start times in local system time.
Example: Premier League (Default)
`lgdash`, or `lgdash -l PL`
Example: Serie A
`lgdash -l SA`
#### Standings
Current state of a league's standings with some statistics for each team.
Example: Premier League (Default)
`lgdash standings`
Example: Serie A
`lgdash standings -l SA`
#### Help
Each command and subcommand supports the `--help` option, for example:
`lgdash --help` and `lgdash --help`
## Commands
`lgdash`
- get live scores and today's scheduled matches
- `-l, --league`: specify a league code
`lgdash schedule`
- get upcoming matches
- `-l, --league`: specify a league code
- `-d, --days`: specify number of days in future
`lgdash standings`
- get league standings
- `-l, --league`: specify a league code
`lgdash leagues`
- get all supported league codes
Raw data
{
"_id": null,
"home_page": "https://github.com/joypauls/league-dashboard",
"name": "lgdash",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.13",
"maintainer_email": null,
"keywords": "cli, soccer, football, statistics, scores, live",
"author": "Joy Paulsen",
"author_email": "joypaulsen3@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a5/14/8c4a88d4a4b4ff881064cee543d8b2cc2ebe261803693dc9eae9eb2b8d0b/lgdash-0.1.3.tar.gz",
"platform": null,
"description": "[](https://www.python.org)\n[](https://badge.fury.io/py/lgdash)\n\n\u26a0\ufe0f This project is currently under active development and considered experimental (all 0.1.x releases).\n\n# League Dashboard (lgdash)\n\nSoccer/football at the command line. \u26bd\n\nUnder the hood the app is calling the [football-data.org](https://www.football-data.org/) API, so an API token from that service is required. Register [here](https://www.football-data.org/pricing) to get one. \n\n## Features\n\n- live scores\n- league standings\n- league schedules\n\n### Currently Supported Leagues\n\n- Premier League (England \ud83c\udff4\udb40\udc67\udb40\udc62\udb40\udc65\udb40\udc6e\udb40\udc67\udb40\udc7f)\n- La Liga (Spain \ud83c\uddea\ud83c\uddf8)\n- Serie A (Italy \ud83c\uddee\ud83c\uddf9)\n- Bundesliga (Germany \ud83c\udde9\ud83c\uddea)\n- Ligue 1 (France \ud83c\uddeb\ud83c\uddf7)\n- UEFA Champions League (Europe)\n\n## Quick Start\n\n### Get API Token\n\nIf you don't have one, register for an API token [here](https://www.football-data.org/pricing).\n\nThen add this line with your token to `.zshrc` or another appropriate startup file.\n```\nexport FOOTBALLDATA_API_TOKEN=<token>\n```\n\n### Install\n\nAvailable on PyPI.\n\n`pip install lgdash`\n\n### How to Use\n\n#### Today's Slate of Matches\n\nLive scores and start times in local system time.\n\nExample: Premier League (Default) \n`lgdash`, or `lgdash -l PL`\n\nExample: Serie A \n`lgdash -l SA`\n\n#### Standings\n\nCurrent state of a league's standings with some statistics for each team.\n\nExample: Premier League (Default) \n`lgdash standings`\n\nExample: Serie A \n`lgdash standings -l SA`\n\n#### Help\n\nEach command and subcommand supports the `--help` option, for example:\n\n`lgdash --help` and `lgdash --help`\n\n\n## Commands\n\n`lgdash`\n- get live scores and today's scheduled matches\n- `-l, --league`: specify a league code\n\n`lgdash schedule`\n- get upcoming matches\n- `-l, --league`: specify a league code\n- `-d, --days`: specify number of days in future\n\n`lgdash standings`\n- get league standings\n- `-l, --league`: specify a league code\n\n`lgdash leagues`\n- get all supported league codes\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command line tool for displaying live soccer scores and statistics.",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/joypauls/league-dashboard",
"Repository": "https://github.com/joypauls/league-dashboard"
},
"split_keywords": [
"cli",
" soccer",
" football",
" statistics",
" scores",
" live"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "71db48d9e22793886314298e11f2eb4b8dc1972896a0777b5dfefca37f1bb7e1",
"md5": "485e641cf68dec662bab6f0fa55fa63c",
"sha256": "6dc764c8c3ac9bf906b5a7b3ca95fd9f685c5ea6034debb1c2333bfc5de805af"
},
"downloads": -1,
"filename": "lgdash-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "485e641cf68dec662bab6f0fa55fa63c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.13",
"size": 10307,
"upload_time": "2024-12-26T16:48:56",
"upload_time_iso_8601": "2024-12-26T16:48:56.403560Z",
"url": "https://files.pythonhosted.org/packages/71/db/48d9e22793886314298e11f2eb4b8dc1972896a0777b5dfefca37f1bb7e1/lgdash-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a5148c4a88d4a4b4ff881064cee543d8b2cc2ebe261803693dc9eae9eb2b8d0b",
"md5": "6fe3e457b6b34e29440bcb1bd71409f0",
"sha256": "fc138916452ee54191a868f912c0e589790cf864e1ed5261c88ab0df76f53a7b"
},
"downloads": -1,
"filename": "lgdash-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "6fe3e457b6b34e29440bcb1bd71409f0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.13",
"size": 9475,
"upload_time": "2024-12-26T16:48:58",
"upload_time_iso_8601": "2024-12-26T16:48:58.605960Z",
"url": "https://files.pythonhosted.org/packages/a5/14/8c4a88d4a4b4ff881064cee543d8b2cc2ebe261803693dc9eae9eb2b8d0b/lgdash-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-26 16:48:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "joypauls",
"github_project": "league-dashboard",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "lgdash"
}
JSON
