pytennisscorer 0.1.0

A Python package for tennis match scoring with support for various match formats

Python Tennis Scorer 🎾

A Python package for tennis match scoring with support for various match formats.

Try it live in your browser! No installation needed - our interactive documentation lets you experiment with PyTennisScorer directly in your browser using Pyodide.

Features

• Support for multiple match formats:
  • Singles Grand Slam (Best of 5 sets)
  • Singles ATP Finals (Best of 3 sets)
  • Doubles Davis Cup (Best of 3 sets)
  • Doubles ATP Tour (Best of 3 with match tiebreak)
  • Doubles Grand Slam (Best of 3 with match tiebreak at 6-6 in final set)
• Standard tennis scoring (0, 15, 30, 40, Advantage)
• Tiebreak support (regular 7-point and match 10-point)
• Score parsing and formatting
• Undo functionality
• Immutable state management

Installation

pip install pytennisscorer

For development:

# Clone the repository
git clone <repository-url>
cd pytennisscorer

# Install with development dependencies
uv pip install -e ".[dev,notebook]"

Quick Start

from pytennisscorer import TennisScorer, MatchType

# Create a new scorer for a Grand Slam singles match
scorer = TennisScorer(MatchType.SINGLES_GRANDSLAM)

# Score points
scorer.increase_score(is_home=True)  # Home player scores
scorer.increase_score(is_home=False)  # Away player scores

# Get current score
print(scorer.get_score())  # Output: "0:0-15:15"

# Complete a game (home wins 4 points)
for _ in range(3):
    scorer.increase_score(is_home=True)
print(scorer.get_score())  # Output: "1:0-0:0"

# Undo last point
scorer.undo()
print(scorer.get_score())  # Output: "0:0-40:15"

# Get winner (returns None while match is ongoing)
winner = scorer.get_winner()  # Returns 'home', 'away', or None

Match Types

The package supports five different match formats:

• MatchType.SINGLES_GRANDSLAM - Best of 5 sets (e.g., Wimbledon, US Open)
• MatchType.SINGLES_ATP_FINALS - Best of 3 sets with regular tiebreaks
• MatchType.DOUBLES_DAVISCUP - Best of 3 sets
• MatchType.DOUBLES_ATPTOUR - Best of 3 with match tiebreak and deciding point
• MatchType.DOUBLES_GRANDSLAM - Best of 3 with match tiebreak at 6-6 in final set

Score Format

Scores are displayed in standard tennis notation:

• Game scores: 0, 15, 30, 40, Ad (advantage)
• Set and match: 6:4;3:6;2:2-30:15 means:
  • First set: 6-4
  • Second set: 3-6
  • Third set: 2-2, current game 30-15

Examples

Complete Match Example

from pytennisscorer import TennisScorer, MatchType

# Start a doubles match
scorer = TennisScorer(MatchType.DOUBLES_DAVISCUP)

# Play a complete first set (6-4)
# Home wins 6 games, away wins 4 games
for game in range(10):
    winner = game % 5 < 3  # Home wins 6, away wins 4
    for _ in range(4):
        scorer.increase_score(is_home=winner)

print(scorer.get_score())  # Output: "6:4;0:0-0:0"

# Check if match is finished
print(scorer.get_winner())  # Output: None (still playing)

Tiebreak Example

from pytennisscorer import TennisScorer, MatchType

scorer = TennisScorer(MatchType.DOUBLES_DAVISCUP)

# Create a scenario leading to tiebreak (6-6)
# ... score to 6-6 in games ...

# In tiebreak, scoring is numerical
scorer.increase_score(is_home=True)
print(scorer.get_score())  # Output: "6:6-1:0"

Development

Running Tests

# Run all tests
pytest

# Run with coverage
pytest --cov=src/pytennisscorer --cov-report=term-missing

# Run only unit tests
pytest -m unit

# Run only integration tests
pytest -m integration

Code Quality

# Format code
ruff format .

# Lint code
ruff check .

# Type checking
mypy src/pytennisscorer

Examples

See the Jupyter notebook in notebooks/tennis_scorer_examples.ipynb for interactive examples.

License

MIT License

Requirements

• Python 3.9+