[](https://github.com/kid-116/Lucy/actions/workflows/pylint.yml)
[](https://github.com/kid-116/Lucy/actions/workflows/pytest.yml)
[](https://github.com/kid-116/Lucy/actions/workflows/publish.yml)
[](https://github.com/kid-116/Lucy/actions/workflows/gh-release.yml)
# Lucy
Lucy, a CLI companion for competitive programming on AtCoder and Codeforces, frees you from tedious
tasks. It automatically fetches sample tests, sets up directories, and lets you test your code with
just a few commands, streamlining your workflow and letting you focus on writing brilliant
solutions.
[Demo](https://github.com/kid-116/Lucy/assets/75692643/1b7195f7-fcd3-4e05-b23e-48061f6ef1b1)
## Supported Languages
- [x] C++
- [ ] Python
## Supported Platforms
- [x] AtCoder
- [ ] Codeforces
## Featues
- [x] Fetch Sample Test Cases
- [ ] Fetch Hidden Test Cases (after the contest ðĪŠ)
- [x] Test Solution
- [x] Setup Snippets
- [ ] Submit Solution
- [ ] What else? ðĪ
## Installation
```
pip install lucy01
```
## Environment Variables
- `LUCY_HOME`
Specify home directory for `lucy`.
## Getting Started
1. Set the environment variable `$LUCY_HOME` as preferred. By default, it uses the `~/.lucy`.
2. Get help!
```
lucy --help
```
Check out the [documentation](https://lucy01.readthedocs.io/en/latest/).
## Directory Structure
```
$LUCY_HOME
âââ .vscode
â âââ cp.code-snippets*
âââ AtCoder
â âââ {ARC177}
â âââ{A}
â â âââ main
â â âââ tests
â â â âââ in
â â â â âââ {00.txt}
â â â â âââ ...
â â â âââ out
â â â âââ {00.txt}
â â â âââ ...
â â âââ main.cpp
â âââ...
âââ Codeforces
âââ common*
âââ base.cpp*
âââ structures
â âââ grid.cpp
â âââ ...
âââ ...
```
- Lucy organizes your competitive programming workspace with a clear directory structure. Besides folders for specific contests and their solutions with `tests`, a key element is the `common` directory. This folder stores reusable code snippets `(*.cpp)`. These snippets can be easily inserted into your solution files using filename prefixes thanks to the `cp.code-snippets` file in the `.vscode` folder. This file, automatically generated with `lucy update-snippets`, facilitates code completion within Visual Studio Code.
[Using Snippets](https://github.com/kid-116/Lucy/assets/75692643/4b747b59-9736-4185-a6ee-9aa1fc843e92)
Raw data
{
"_id": null,
"home_page": null,
"name": "lucy01",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "cp, cli, companion, atcoder, codeforces, tester, snippets, lucy",
"author": null,
"author_email": "Mehul Todi <mehul116.dev@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/b1/be/c6493f696e8a3325d3306f6b15e5bf065151de6c8258072847582b8795ec/lucy01-1.0.0.tar.gz",
"platform": null,
"description": "[](https://github.com/kid-116/Lucy/actions/workflows/pylint.yml)\n[](https://github.com/kid-116/Lucy/actions/workflows/pytest.yml)\n[](https://github.com/kid-116/Lucy/actions/workflows/publish.yml)\n[](https://github.com/kid-116/Lucy/actions/workflows/gh-release.yml)\n\n# Lucy\n\nLucy, a CLI companion for competitive programming on AtCoder and Codeforces, frees you from tedious\ntasks. It automatically fetches sample tests, sets up directories, and lets you test your code with\njust a few commands, streamlining your workflow and letting you focus on writing brilliant\nsolutions.\n\n[Demo](https://github.com/kid-116/Lucy/assets/75692643/1b7195f7-fcd3-4e05-b23e-48061f6ef1b1)\n\n## Supported Languages\n- [x] C++\n- [ ] Python\n\n## Supported Platforms\n- [x] AtCoder\n- [ ] Codeforces\n\n## Featues\n- [x] Fetch Sample Test Cases\n- [ ] Fetch Hidden Test Cases (after the contest \ud83e\udd2a)\n- [x] Test Solution\n- [x] Setup Snippets\n- [ ] Submit Solution\n- [ ] What else? \ud83e\udd14\n\n## Installation\n```\npip install lucy01\n```\n\n## Environment Variables\n- `LUCY_HOME`\n\n Specify home directory for `lucy`.\n\n## Getting Started\n1. Set the environment variable `$LUCY_HOME` as preferred. By default, it uses the `~/.lucy`.\n2. Get help!\n ```\n lucy --help\n ```\n Check out the [documentation](https://lucy01.readthedocs.io/en/latest/).\n\n## Directory Structure\n```\n$LUCY_HOME\n\u251c\u2500\u2500 .vscode\n\u2502 \u2514\u2500\u2500 cp.code-snippets*\n\u251c\u2500\u2500 AtCoder\n\u2502 \u2514\u2500\u2500 {ARC177}\n\u2502 \u251c\u2500\u2500{A}\n\u2502 \u2502 \u251c\u2500\u2500 main\n\u2502 \u2502 \u251c\u2500\u2500 tests\n\u2502 \u2502 \u2502 \u251c\u2500\u2500 in\n\u2502 \u2502 \u2502 \u2502 \u251c\u2500\u2500 {00.txt}\n\u2502 \u2502 \u2502 \u2502 \u2514\u2500\u2500 ...\n\u2502 \u2502 \u2502 \u2514\u2500\u2500 out\n\u2502 \u2502 \u2502 \u251c\u2500\u2500 {00.txt}\n\u2502 \u2502 \u2502 \u2514\u2500\u2500 ...\n\u2502 \u2502 \u2514\u2500\u2500 main.cpp\n\u2502 \u2514\u2500\u2500...\n\u251c\u2500\u2500 Codeforces\n\u2514\u2500\u2500 common*\n \u251c\u2500\u2500 base.cpp*\n \u251c\u2500\u2500 structures\n \u2502 \u251c\u2500\u2500 grid.cpp\n \u2502 \u2514\u2500\u2500 ...\n \u2514\u2500\u2500 ...\n```\n\n- Lucy organizes your competitive programming workspace with a clear directory structure. Besides folders for specific contests and their solutions with `tests`, a key element is the `common` directory. This folder stores reusable code snippets `(*.cpp)`. These snippets can be easily inserted into your solution files using filename prefixes thanks to the `cp.code-snippets` file in the `.vscode` folder. This file, automatically generated with `lucy update-snippets`, facilitates code completion within Visual Studio Code.\n\n [Using Snippets](https://github.com/kid-116/Lucy/assets/75692643/4b747b59-9736-4185-a6ee-9aa1fc843e92)\n",
"bugtrack_url": null,
"license": null,
"summary": "CLI companion for CP.",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://lucy01.readthedocs.io/en/latest/",
"Issues": "https://github.com/kid-116/Lucy/issues",
"Repository": "https://github.com/kid-116/Lucy"
},
"split_keywords": [
"cp",
" cli",
" companion",
" atcoder",
" codeforces",
" tester",
" snippets",
" lucy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb296b85cecace8354f2ee1418c8f6392b8a4a4bf05c41150b3671691d146a59",
"md5": "77b96834442ea902851457ba0c3c6e06",
"sha256": "7a87b4bb6f32a632c32b2a0f221cdd9fb728779addbaf9da9a8d038a3088330c"
},
"downloads": -1,
"filename": "lucy01-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "77b96834442ea902851457ba0c3c6e06",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13070,
"upload_time": "2024-06-03T08:01:56",
"upload_time_iso_8601": "2024-06-03T08:01:56.937480Z",
"url": "https://files.pythonhosted.org/packages/cb/29/6b85cecace8354f2ee1418c8f6392b8a4a4bf05c41150b3671691d146a59/lucy01-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b1bec6493f696e8a3325d3306f6b15e5bf065151de6c8258072847582b8795ec",
"md5": "0d31f9ee13240385d695cfaf44119646",
"sha256": "e8389a48c82fb78a2f5b7f514664a6f13c591f1ca4db13938fcce84b8ec034d1"
},
"downloads": -1,
"filename": "lucy01-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "0d31f9ee13240385d695cfaf44119646",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 11966,
"upload_time": "2024-06-03T08:01:58",
"upload_time_iso_8601": "2024-06-03T08:01:58.500518Z",
"url": "https://files.pythonhosted.org/packages/b1/be/c6493f696e8a3325d3306f6b15e5bf065151de6c8258072847582b8795ec/lucy01-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-03 08:01:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kid-116",
"github_project": "Lucy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lucy01"
}
JSON
