# Welcome to the CPCli project repository
Stands for Competitive Programmers Command Line Interface A CLI tool for competitive programmers that allows you to track statistic and improve overall workflow during competitions

## Documentation

You can view the documentation for the project [here](https://compprogtools.github.io/CPCli/) (**This includes stuff related to installation and all the commands**)

## Features
- Link accounts for LeetCode, and CodeForce for rating updates and etc
- Sync accounts using a command to sync the rating of all your accounts at the same time
- Add templates for certain problems (permutations, djikstra, etc) and access them easily
- Submit code for Leetcode, and Codeforces problems throught the terminal **(coming soon if possible)**
- Use a config to set name, change accounts, and set preferences
- Use streaks for motivation (RAAAAAAHHHHH)

## Tools
- Python
- Rich console API
- Unofficial LeetCode API (https://leetcode-api-pied.vercel.app/)
- Official CodeForces API (https://codeforces.com/apiHelp)
- Pip Package Manager
- Jekyll Mkdocs Theme

## Contributing

Contributions are always welcome!

See [CONTRIBUTING.md](https://github.com/CompProgTools/CPCli/blob/main/CONTRIBUTE.md) for ways to get started.

Please adhere to this project's `code of conduct`.

## AI Usage

AI was used in this project in order to give more ideas of what other features I could add, by using search feature for concerns online. It was also used to figure out some logical code for stuff such as Rich module, and json

## Environment Variables

For secure CodeForces API calls, you require an API key refer to the Authorization section on https://codeforces.com/apiHelp