elochess 0.5.0

A simple python package for calculating chess ratings.

♟️ elochess

elochess is a simple python package for calculating chess ratings.

✨ Rating Systems

• FIDE Elo used by the FIDE
• Deutsche Wertungszahl used by the German Chess Federation
• USCF Rating used by the US Chess Federation

🎯 Accuracy

This project aims to replicate the exact official rating calulations.

For FIDE Elo and DWZ, the calculated ratings have been confirmed to be accurate in a large number of real scenarios.

For USCF rating, the calculated ratings are an estimate based on the "official" Rating Estimator. Here as well, it has been confirmed to be accurate in a large number of real scenarios. But keep in mind that this is a mere estimate of the real calculation which can only be performed by knowing all results of all players.

📦 Installation

pip install elochess

For CLI support:

pip install elochess[cli]

For API support:

pip install elochess[api]

🚀 Usage

🐍 Python

from elochess.elo import EloCalculator

current_rating = 1500
opponent_ratings = [1642, 1425, 1432]
score = 2.5

new_rating = EloCalculator.update_rating(
    current_rating,
    opponent_ratings,
    score
)

💻 CLI

elochess-cli update elo \
  --current 1500 \
  --opponent 1642 \
  --opponent 1425 \
  --opponent 1432 \
  --score 2.5

🌐 API

elochess-api

Check out the OpenAPI Spec at http://127.0.0.1:8000/docs.

📄 License

This project is licensed under the MIT License.