https://github.com/lopezton/tennis-score-processor

Open source library dedicated to processing tennis match scoring and providing analytics over scoring data.
https://github.com/lopezton/tennis-score-processor

analytics library scoring sports tennis tennis-score-processor

Last synced: 6 months ago
JSON representation

Open source library dedicated to processing tennis match scoring and providing analytics over scoring data.

• Host: GitHub
• URL: https://github.com/lopezton/tennis-score-processor
• Owner: lopezton
• License: apache-2.0
• Created: 2017-08-12T18:12:26.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2020-04-20T07:01:50.000Z (about 6 years ago)
• Last Synced: 2025-07-27T13:48:49.431Z (11 months ago)
• Topics: analytics, library, scoring, sports, tennis, tennis-score-processor
• Language: Java
• Homepage: https://lopezton.github.io/tennis-score-processor
• Size: 165 KB
• Stars: 6
• Watchers: 2
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: docs/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Tennis Score Processor

> Tennis Score Processor is an open source library dedicated to processing tennis match scoring.

[![Build Status](https://travis-ci.org/lopezton/tennis-score-processor.svg?branch=master)](https://travis-ci.org/lopezton/tennis-score-processor)

[![Coverage Status](https://coveralls.io/repos/github/lopezton/tennis-score-processor/badge.svg?branch=master)](https://coveralls.io/github/lopezton/tennis-score-processor?branch=master)

![Maven Central](https://img.shields.io/maven-central/v/com.tonelope.tennis/scoreprocessor.svg)

Tennis Score Processor is a Java based library that records and processes tennis match data on a stroke-by-stroke or point-by-point bases. 

## Overview

Tennis Score Processor uses a main processor object called ```MatchProcessor``` to update and modify the ```Match``` object, a simple POJO containing match data.  See the following diagram:  

![Entry Point](docs/images/uml/entry-point.png)  

## Quick Links

* [Request a feature](https://github.com/lopezton/tennis-score-processor/issues/new?template=issue_template.md)

* [Report a defect](https://github.com/lopezton/tennis-score-processor/issues/new?template=defect_template.md)

## Installation

### Maven

Tennis Score Processor is hosted on [Maven Central](https://search.maven.org/). Include the following in your project's pom.xml:  

```xml

    com.tonelope.tennis

    scoreprocessor

    0.1.0

```

### Manual

You can download the .jar file directly from the [Github release page](https://github.com/lopezton/tennis-score-processor/releases) and include it on your project's classpath.

## Usage

### Use Cases

Use Tennis Score Processor to:  

* Record match data on a stroke-by-stroke or point-by-point basis

* Analyze recorded match data

* Process tennis scoring results in real-time

* Build a real working tennis scoreboard

* Whatever else your imagine can dream up!

### Get Started

Getting started with Tennis Score Processor is easy. Create a ```Match``` entity and update it with the necessary information for the processor to be able to perform updates. See the following code sample:  

```java

public static void main(String[] args) {

	// Build the match data

	Player player1 = new Player("Roger", "Federer");

	Player player2 = new Player("Rafael", "Nadal");

		

	List players = new ArrayList<>();

	players.add(player1);

	players.add(player2);

		

	// Initialize the playerConfig data

	PlayerConfig playerConfig = new PlayerConfig(players, player1, player2);

		

	// Utilize the framework's match factory to create a new match entity

	MatchFactory matchFactory = new DefaultMatchFactory();

		

	// Instantiate the matchProcessor

	MatchProcessor matchProcessor = new MatchProcessor(matchFactory.create(new MatchRules(), playerConfig));

		

	// Use the matchProcessor to update match results on stroke or point basis

	matchProcessor.update(new Stroke(player1, StrokeType.FIRST_SERVE, false, true));

}

```

## Development setup

1. Fork/Clone the Repository

2. Install Lombok into your IDE

3. Import the project into your IDE

## Contributing

See [Contributing](/docs/CONTRIBUTING.md) for information on how to contribute to this project. Contributions are open to the community and very much appreciated!

## Meta

The application is currently in it's discovery phase and at the time supports singles scoring features. As the project grows, several types of scoring will be supported as well as other great features including:

* Doubles Scoring

* Live/Post Match Reporting

* Generated Match Metrics

Feedback and Pull Requests are extremely welcome!

Maintained by: Tony Lopez – tony.lopez1013@gmail.com

Distributed under the Apache License. See ``LICENSE`` for more information.

[https://github.com/lopezton/tennis-score-processor](https://github.com/lopezton/tennis-score-processor)