README.md

ratings-calculator

Calculate ratings based on the CFC model!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This program was created to calculate CFC ratings for our members. A future implementation would be in embeding this information onto a web service that will automatically calculate ratings. Another idea is to build a HHCC rating system to let our members play each other in-person.

This program runs by calculating CFC ratings from the publicly accessible CFC algorithm viewable on the CFC handbook. It also allows a user to visualize cfc ratings, calculate norms, and titles, and check ratings.

A future goal is to use the public CFC API to connect to user's CFC ID and run various algorithms to automate the finding user data aspect.

(back to top)

(back to top)

Getting Started

This is how you can get started using, developing, or configuring our project.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• python

  Python version 3.10 should be installed
  

• pip

  python get-pip.py
  

  • The latest version of pip available

• chess

  pip install chess

  • python library chess

• requests

  pip install requests
  

  • python library requests

Installation

Below is the installation process for running our code locally.

1. Clone the repo

   git clone https://github.com/Hart-House-Chess-Club/ratings-calculator.git

2. Launch the program

   python main.py
   

(back to top)

Usage

This project is the beginning of many related projects part of the Hart House Chess Club's development of open-source Canadian chess software.

(back to top)

Roadmap

• Add program configuration onto a web service
• Add configuration for FIDE ratings.
• Add configuration for API from chess.ca
• Add configuration for chess.com api
• Add integration with lichess.org
• Multi-language Support (must be available in french for CFC)
  • French

See the open issues for a full list of proposed features ( and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL License. See LICENSE for more information.

(back to top)

Contact

Hart House Chess Club Executive Board

• harthousechess.com
• [email protected]

Victor Zheng

• @victor-zheng-codes

Project Link: https://github.com/Hart-House-Chess-Club/ratings-calculator

(back to top)

Acknowledgments

• Chess Federation of Canada
• lichess.org

(back to top)