Skip to main content

Football Stats Scraper - Footstats CLI

Project description

Footstats CLI

Football player stats, transfers, and market values — straight from your terminal.

License: MIT UV Python


Overview

Footstats is an open-source CLI tool that lets you search for any football player and retrieve their profile, transfer history, and match statistics — all from your terminal, powered by data from Transfermarkt.


Features

  • Player Search — Search any player by name
  • Player Profile — Market value, age, club, position, nationality, and more
  • Transfer History — Full transfer history with fees and market values
  • Match Stats — Per-game stats including goals, assists, cards, minutes, passes, and shots
  • Interactive Menu — Navigate with a single keypress
  • Direct Commands — Call any command directly with arguments

Data Sources

Source Data
Transfermarkt Market value, transfers, match stats, player profile

Requirements


Installation

With pip

pip install footstats-cli

With uv (recommended)

uv tool install footstats-cli

That's it — the footstats command is now available globally in your terminal.

Upgrade to latest version

uv tool upgrade footstats-cli

Uninstall

uv tool uninstall footstats-cli

Usage

Interactive menu

footstats

Direct commands

footstats player "Cristiano Ronaldo"
footstats transfer-history "Lionel Messi"
footstats stats "Erling Haaland"

Options

footstats --help
footstats --version

Configuration

By default the tool works out of the box. To customize request behavior, create a .env file in your working directory:

USER_AGENT=Mozilla/5.0 (Windows NT 10.0; Win64; x64)...
ACCEPT_LANGUAGE=en-US,en;q=0.5
ACCEPT_ENCODING=gzip, deflate
REQUEST_DELAY=3.0   # seconds between requests — increase if getting blocked

Project Structure

footstats-scraper/
├── src/
│   ├── cli/
│   │   ├── main.py          # CLI entry point
│   │   └── utils/           # Display helpers
│   ├── models/              # Dataclasses
│   ├── providers/           # Scraping logic
│   └── utils/               # Config, parsing, requests
├── tests/
├── .env.example
├── pyproject.toml
└── README.md

Development

1. Clone the repository

git clone https://github.com/Marin2409/footstats-cli.git
cd footstats-cli

2. Install UV

# macOS
brew install uv

# Linux/macOS
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

3. Install dependencies

uv sync

4. Set up environment variables

cp .env.example .env

5. Install the CLI locally

uv pip install -e .

Run directly without installing

# With Python
python -m src.cli.main [command] [argument]

# With UV
uv run python -m src.cli.main [command] [argument]
Segment Description
src Root source folder
cli CLI parent folder
main Entry point file
command Action (e.g. player, stats)
argument Player name (e.g. "Cristiano")

Run Tests

pytest tests/test_providers.py

Disclaimer

This project is an independent open-source tool and is not affiliated with, endorsed by, or sponsored by Transfermarkt or any other data provider. Use it at your own risk and ensure compliance with their Terms of Service and avoid excessive requests. The REQUEST_DELAY setting in .env helps ensure responsible usage.

Users are solely responsible for ensuring that their use of this software complies with applicable laws, regulations, website terms of service, robots.txt policies, and rate-limiting requirements.

The authors provide this software for educational and research purposes only and make no representations regarding the legality or appropriateness of its use in any particular jurisdiction or against any particular website.


User Responsibility

By using this software, you acknowledge that you are responsible for determining whether your use complies with applicable laws, regulations, and the terms of service of any websites you access.

The authors are not responsible for how users choose to use this software.


Contributing

Contributions are welcome! Please open an issue before submitting a pull request so we can discuss the change.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/my-feature)
  3. Commit your changes (git commit -m 'Add my feature')
  4. Push to the branch (git push origin feature/my-feature)
  5. Open a Pull Request

License

MIT License — see LICENSE for details.

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

footstats_cli-0.1.3.tar.gz (29.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

footstats_cli-0.1.3-py3-none-any.whl (13.6 kB view details)

Uploaded Python 3

File details

Details for the file footstats_cli-0.1.3.tar.gz.

File metadata

  • Download URL: footstats_cli-0.1.3.tar.gz
  • Upload date:
  • Size: 29.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for footstats_cli-0.1.3.tar.gz
Algorithm Hash digest
SHA256 bd62e9d8bc231c8ada03110a713207cb1307cc23c709b7e29ea792d2a3d546da
MD5 9e292618736df12775d06865dfbe89d6
BLAKE2b-256 5c47a05c2258ea7d78a232cee20c48ccb7567df680d44589a2fc2c76d2677d07

See more details on using hashes here.

Provenance

The following attestation bundles were made for footstats_cli-0.1.3.tar.gz:

Publisher: publish.yml on Marin2409/footstats-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file footstats_cli-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: footstats_cli-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 13.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for footstats_cli-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7a33885e54b8b525366e08733fb63ba2ef3c45c10dc98da9c69011a0daeed0d2
MD5 c4f2c471df0b0e1e8e2184c2ae4c31cf
BLAKE2b-256 a1504da9b5bc689d5bd8078a8ea8050870163cd2bbdb740cafc57dfcea8b58db

See more details on using hashes here.

Provenance

The following attestation bundles were made for footstats_cli-0.1.3-py3-none-any.whl:

Publisher: publish.yml on Marin2409/footstats-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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