# pythoncf
`pythoncf` is the perfect tool for Codeforces enthusiasts who prefer to stay nestled in their comfy terminals rather than venturing out into the wilds of the web. Get your Codeforces API data fix without ever leaving your cozy command line setup.
## 🚀 Features
- **User Information**: Retrieve details about a specific Codeforces user.
- **Rating Graph**: Display the rating chart of a user.
- **Contest Information**: Get details about a specific contest.
- **Problem Retrieval**: Fetch all problems or filter by tags.
- **Blog Entries**: View specific blog entries and user blog entries.
- **Rating Changes**: Get the rating changes for a contest.
- **User Status**: Retrieve submission status of a user in a contest.
- **Contest Status**: Get the status of submissions in a contest.
- **User Comparison**: Compare two users' information.
## 📦 Installation
To install `pythoncf`, use `pip`:
```bash
pip install pythoncf
```
### Additional Requirements
For the user comparison feature, you need to install **GNUplot**. You can install it with:
- **Ubuntu/Debian:**
```bash
sudo apt-get install gnuplot
```
- **macOS (using Homebrew):**
```bash
brew install gnuplot
```
- **Windows:**
Download and install GNUplot from the [official website](http://www.gnuplot.info/).
## 🛠️ Usage
The following examples illustrate the usage of `pythoncf`:
- **Display user details:**
```bash
pythoncf -userinfo ImFire
```
- **Display rating chart of a user:**
```bash
pythoncf -graph ImFire
```
- **Get details of a specific contest:**
```bash
pythoncf -contestinfo 1901
```
- **Retrieve all problems:**
```bash
pythoncf -prob
```
### View available commands for prob.
- `list n`: List `n` problems.
- `listc cid`: List problems of contest ID `cid`.
- `listn name`: View problem details specified by name.
- **Retrieve problems with a specific tag:**
```bash
pythoncf -prob --tag dp
```
- **Get rating changes for a contest:**
```bash
pythoncf -ratingchange 1901
```
- **Get rating changes for a contest with a specific handle:**
```bash
pythoncf -ratingchange 1901 --handle ImFire
```
- **Get submissions of a specified user:**
```bash
pythoncf -submission ImFire
```
- **Get submissions with pagination:**
```bash
pythoncf -submission ImFire --fr 1 --count 10
```
- **Get contest submissions:**
```bash
pythoncf -submission 1901
```
- **Get contest submissions with pagination:**
```bash
pythoncf -conteststatus 1901 --fr 1 --count 10
```
- **Compare two users:**
```bash
pythoncf --compare ImFire Petr
```
## 📜 Arguments
| Argument | Description |
|-----------------------------------------------|-------------------------------------------------------|
| `-userinfo`, `--user <HANDLE>` | Display user details. |
| `-graph`, `--graph <HANDLE>` | Display the rating chart of a user. |
| `-contestinfo`, `--contest <CONTEST ID>` | Get details of a contest. |
| `--gym` | Optional argument to list gym contests (use with `-contestinfo`). |
| `-prob`, `--problem` | Retrieve all problems. |
| `--tag <TAG>` | Tag of problems to retrieve. |
| `-ratingchange`, `--ratingchange <CONTEST ID>`| Get rating changes for a contest. |
| `--handle <HANDLE>` | Specify a handle for rating change queries. |
| `-submission`, `--userstatus <HANDLE>` | Get submissions of a specified user. |
| `--fr <FROM>` | 1-based index of the first submission to return. |
| `--count <COUNT>` | Number of returned submissions. |
| `-conteststatus`, `--cstatus <CONTEST ID>` | Get contest submissions. |
| `--compare <USER1 USER2>` | Compare two users. |
## Planned Features (*Working on it*)
- `-allblog`, `--blog` `<BLOG ID>`: View a specific blog entry.
- `-userblog`, `--userblog` `<HANDLE>`: Get blog entries of a user.
- `--login` `<USERNAME>` `<PASSWORD>`: Manage login credentials.
- `--submit` `<PROBLEM ID>` `<SOLUTION FILE>`: Submit solutions to problems.
- `--render` `<PROBLEM ID>`: Improve rendering of problem statement.
## 📞 Facing Issue ??
Sudhir Sharma:
[](https://www.linkedin.com/in/sudhirsharma87)
[](mailto:sudhirsharma34567@gmail.com)
## 🤝 Contributing
Contributions are welcome! If you have suggestions or improvements, please submit a pull request or open an issue.
## 📝 License
This project is licensed under the **MIT License**. See the [LICENSE](https://github.com/Sudhir878786/pythoncf/LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/Sudhir878786/pythoncf",
"name": "pythoncf",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Codeforces, cli, command line, terminal",
"author": "Sudhir_Sharma",
"author_email": "sudhirsharma@iitbhilai.ac.in",
"download_url": "https://files.pythonhosted.org/packages/d5/89/a95969a14785872eed6b0fa2121c42cd0d3ef95221601099867488cdfeff/pythoncf-1.1.2.tar.gz",
"platform": null,
"description": "# pythoncf\r\n\r\n\r\n\r\n`pythoncf` is the perfect tool for Codeforces enthusiasts who prefer to stay nestled in their comfy terminals rather than venturing out into the wilds of the web. Get your Codeforces API data fix without ever leaving your cozy command line setup.\r\n\r\n\r\n\r\n## \ud83d\ude80 Features\r\n\r\n\r\n\r\n- **User Information**: Retrieve details about a specific Codeforces user.\r\n\r\n- **Rating Graph**: Display the rating chart of a user.\r\n\r\n- **Contest Information**: Get details about a specific contest.\r\n\r\n- **Problem Retrieval**: Fetch all problems or filter by tags.\r\n\r\n- **Blog Entries**: View specific blog entries and user blog entries.\r\n\r\n- **Rating Changes**: Get the rating changes for a contest.\r\n\r\n- **User Status**: Retrieve submission status of a user in a contest.\r\n\r\n- **Contest Status**: Get the status of submissions in a contest.\r\n\r\n- **User Comparison**: Compare two users' information.\r\n\r\n\r\n\r\n## \ud83d\udce6 Installation\r\n\r\n\r\n\r\nTo install `pythoncf`, use `pip`:\r\n\r\n\r\n\r\n```bash\r\n\r\npip install pythoncf\r\n\r\n```\r\n\r\n### Additional Requirements\r\n\r\n\r\n\r\nFor the user comparison feature, you need to install **GNUplot**. You can install it with:\r\n\r\n\r\n\r\n- **Ubuntu/Debian:**\r\n\r\n\r\n\r\n ```bash\r\n\r\n sudo apt-get install gnuplot\r\n\r\n ```\r\n\r\n\r\n\r\n- **macOS (using Homebrew):**\r\n\r\n\r\n\r\n ```bash\r\n\r\n brew install gnuplot\r\n\r\n ```\r\n\r\n\r\n\r\n- **Windows:**\r\n\r\n\r\n\r\n Download and install GNUplot from the [official website](http://www.gnuplot.info/).\r\n\r\n\r\n\r\n\r\n\r\n## \ud83d\udee0\ufe0f Usage\r\n\r\n\r\n\r\nThe following examples illustrate the usage of `pythoncf`:\r\n\r\n\r\n\r\n- **Display user details:**\r\n\r\n\r\n\r\n ```bash\r\n\r\n pythoncf -userinfo ImFire\r\n\r\n ```\r\n\r\n\r\n\r\n\r\n\r\n- **Display rating chart of a user:**\r\n\r\n\r\n\r\n ```bash\r\n\r\n pythoncf -graph ImFire\r\n\r\n ```\r\n\r\n\r\n\r\n\r\n\r\n- **Get details of a specific contest:**\r\n\r\n\r\n\r\n ```bash\r\n\r\n pythoncf -contestinfo 1901\r\n\r\n ```\r\n\r\n\r\n\r\n\r\n\r\n- **Retrieve all problems:**\r\n\r\n\r\n\r\n ```bash\r\n\r\n pythoncf -prob\r\n\r\n ```\r\n\r\n ### View available commands for prob. \r\n\r\n- `list n`: List `n` problems. \r\n\r\n\r\n\r\n \r\n\r\n\r\n\r\n- `listc cid`: List problems of contest ID `cid`. \r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n- `listn name`: View problem details specified by name. \r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n- **Retrieve problems with a specific tag:**\r\n\r\n\r\n\r\n ```bash\r\n\r\n pythoncf -prob --tag dp\r\n\r\n ```\r\n\r\n\r\n\r\n\r\n\r\n- **Get rating changes for a contest:**\r\n\r\n\r\n\r\n ```bash\r\n\r\n pythoncf -ratingchange 1901\r\n\r\n ```\r\n\r\n\r\n\r\n\r\n\r\n- **Get rating changes for a contest with a specific handle:**\r\n\r\n\r\n\r\n ```bash\r\n\r\n pythoncf -ratingchange 1901 --handle ImFire\r\n\r\n ```\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n- **Get submissions of a specified user:**\r\n\r\n\r\n\r\n ```bash\r\n\r\n pythoncf -submission ImFire\r\n\r\n ```\r\n\r\n\r\n\r\n\r\n\r\n- **Get submissions with pagination:**\r\n\r\n\r\n\r\n ```bash\r\n\r\n pythoncf -submission ImFire --fr 1 --count 10\r\n\r\n ```\r\n\r\n\r\n\r\n- **Get contest submissions:**\r\n\r\n\r\n\r\n ```bash\r\n\r\n pythoncf -submission 1901\r\n\r\n ```\r\n\r\n\r\n\r\n\r\n\r\n- **Get contest submissions with pagination:**\r\n\r\n\r\n\r\n ```bash\r\n\r\n pythoncf -conteststatus 1901 --fr 1 --count 10\r\n\r\n ```\r\n\r\n\r\n\r\n- **Compare two users:**\r\n\r\n\r\n\r\n ```bash\r\n\r\n pythoncf --compare ImFire Petr\r\n\r\n ```\r\n\r\n\r\n\r\n\r\n\r\n## \ud83d\udcdc Arguments\r\n\r\n\r\n\r\n| Argument | Description |\r\n\r\n|-----------------------------------------------|-------------------------------------------------------|\r\n\r\n| `-userinfo`, `--user <HANDLE>` | Display user details. |\r\n\r\n| `-graph`, `--graph <HANDLE>` | Display the rating chart of a user. |\r\n\r\n| `-contestinfo`, `--contest <CONTEST ID>` | Get details of a contest. |\r\n\r\n| `--gym` | Optional argument to list gym contests (use with `-contestinfo`). |\r\n\r\n| `-prob`, `--problem` | Retrieve all problems. |\r\n\r\n| `--tag <TAG>` | Tag of problems to retrieve. |\r\n\r\n| `-ratingchange`, `--ratingchange <CONTEST ID>`| Get rating changes for a contest. |\r\n\r\n| `--handle <HANDLE>` | Specify a handle for rating change queries. |\r\n\r\n| `-submission`, `--userstatus <HANDLE>` | Get submissions of a specified user. |\r\n\r\n| `--fr <FROM>` | 1-based index of the first submission to return. |\r\n\r\n| `--count <COUNT>` | Number of returned submissions. |\r\n\r\n| `-conteststatus`, `--cstatus <CONTEST ID>` | Get contest submissions. |\r\n\r\n| `--compare <USER1 USER2>` | Compare two users. |\r\n\r\n\r\n\r\n## Planned Features (*Working on it*)\r\n\r\n\r\n\r\n- `-allblog`, `--blog` `<BLOG ID>`: View a specific blog entry.\r\n\r\n- `-userblog`, `--userblog` `<HANDLE>`: Get blog entries of a user.\r\n\r\n- `--login` `<USERNAME>` `<PASSWORD>`: Manage login credentials. \r\n\r\n- `--submit` `<PROBLEM ID>` `<SOLUTION FILE>`: Submit solutions to problems. \r\n\r\n- `--render` `<PROBLEM ID>`: Improve rendering of problem statement. \r\n\r\n\r\n\r\n\r\n\r\n## \ud83d\udcde Facing Issue ??\r\n\r\n\r\n\r\nSudhir Sharma: \r\n\r\n[](https://www.linkedin.com/in/sudhirsharma87) \r\n\r\n[](mailto:sudhirsharma34567@gmail.com)\r\n\r\n\r\n\r\n## \ud83e\udd1d Contributing\r\n\r\n\r\n\r\nContributions are welcome! If you have suggestions or improvements, please submit a pull request or open an issue.\r\n\r\n\r\n\r\n## \ud83d\udcdd License\r\n\r\nThis project is licensed under the **MIT License**. See the [LICENSE](https://github.com/Sudhir878786/pythoncf/LICENSE) file for details.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "`pythoncf` is your command-line companion for all things Codeforces.",
"version": "1.1.2",
"project_urls": {
"Homepage": "https://github.com/Sudhir878786/pythoncf"
},
"split_keywords": [
"codeforces",
" cli",
" command line",
" terminal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0c499627a96de2d81412a4bfc6c7fe5240ab9f7e86b876f7f0b507da7c4e1f2d",
"md5": "d43135877221d5612d50b030cc0b9d22",
"sha256": "8a30bcb146b3dd3ee2fdca8f1e35d0cc5a803aa376686f424ac7e5c5d96a60fc"
},
"downloads": -1,
"filename": "pythoncf-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d43135877221d5612d50b030cc0b9d22",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 17591,
"upload_time": "2024-08-25T07:07:53",
"upload_time_iso_8601": "2024-08-25T07:07:53.190828Z",
"url": "https://files.pythonhosted.org/packages/0c/49/9627a96de2d81412a4bfc6c7fe5240ab9f7e86b876f7f0b507da7c4e1f2d/pythoncf-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d589a95969a14785872eed6b0fa2121c42cd0d3ef95221601099867488cdfeff",
"md5": "ef41a2c67b621ea93fd4f24d81e67362",
"sha256": "b2284889a85e26fc01857176dd0a11541c8b5d3e472978de43c06c11978e58af"
},
"downloads": -1,
"filename": "pythoncf-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "ef41a2c67b621ea93fd4f24d81e67362",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 819106,
"upload_time": "2024-08-25T07:07:56",
"upload_time_iso_8601": "2024-08-25T07:07:56.600232Z",
"url": "https://files.pythonhosted.org/packages/d5/89/a95969a14785872eed6b0fa2121c42cd0d3ef95221601099867488cdfeff/pythoncf-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 07:07:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Sudhir878786",
"github_project": "pythoncf",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pythoncf"
}
JSON
