khalidbelk/MyChess
1
0
Fork 0
mirror of https://github.com/khalidbelk/MyChess.git synced 2026-06-21 03:12:42 +02:00
Code Issues Projects Releases Packages Wiki Activity
🧩 An app that uses Chess.com Public API to search up information about users, their games and more.
15 commits 1 branch 0 tags 36 KiB
  • Python 86.5%
  • Makefile 13.5%
Find a file
Exact
khalidbelk 04bdd1d294 feat: user, month and year as name for .pgn file 
This feature saves the pgn file in username_month_year.pgn format instead of filename.pgn
2024-01-28 03:48:17 +01:00
src feat: user, month and year as name for .pgn file 2024-01-28 03:48:17 +01:00
.gitignore feat: remove .pgn file with Makefile 2024-01-28 02:12:52 +01:00
Makefile feat: remove .pgn file with Makefile 2024-01-28 02:12:52 +01:00
README.md feat: add image to Readme 2024-01-28 03:08:47 +01:00

README.md

MyChess

This project is a basic application created for experimenting with the Chess.com public API. It provides a simple command-line interface to interact with the API and retrieve information about users and their games.

Requirements

Before using mychess, ensure you have the following installed on your system:

  • Python 3
  • Pip (Python package installer)

Usage

First of all, compile the project at the root directory using the following command:

make

After building, the executable mychess will be generated. You can use it as follows:

./mychess -u user [gamesYear gamesMonth]
    user            is the Chess.com username. This flag alone provides information about the user.
    gamesYear       is the year of the user's games you want to download
    gamesMonth      is the month of the user's games you want to download