README.md

CodeforcesTerminal

This is a Go Program that aims to provides various useful analytical tools for the Competitive Coding Platform 'Codeforces'.

Installation

1. Clone the repository on your PC.
   
2. Naviagate to the repository in your system.
   
3. To compile, run go build main.go
   
4. After compiling, you can observe an executable file named 'main'.
   
5. To execute, run ./main
   

Functionality Provided

Currently the program provides contest level and user level analytics. Some of them include:

Contest level analytics

1. Stats.ContestStats.GetTopRanker function provides the top ranker for a given contest and the corresponding users rating changes.
   
2. Stats.ContestStats.GetTopAchiever function provides the top rating gainer for a given contest and the corresponding users rating changes.
   
3. Stats.ContestStats.GetNumberOfParticipants function provides the number of participants for a given contest.
   
4. Stats.ContestStats.AverageChangeInRating function provides the rating change in a contest.
   
5. Stats.ContestStats.GetUserInContest. function provides the information and rating change for the given user.
   
6. Stats.ContestStats.GetNumberOfOvertakes. function provides the number of users who were overtaken by the given user in the contest.
   
7. Stats.ContestStats.GetNumberOfSurpassed. function provides the number of users who overtook the given user in the contest.