Contest Builder is a CLI tool designed to simplify the process of managing programming contest solutions by providing a structured workflow for organizing, compiling, and testing code.
- Quickly generate the folder and file structure for a contest's problems.
- Customize templates for generating solution files.
- Compile and run solutions with ease.
- Test solutions for correctness.
You can install Contest Builder via pip:
pip install contest-builder
In order to specify the template files and default options for the future, you need to initialize a folder inorder to store the files of the contest over there.
contest-builder --init
- this will generate:
- A config file named
cb-config.json
, and - A
templates
folder which stores language specific templates.
- A config file named
To generate the folder and file structure for a contest, use the contest-builder command with the --name
option:
contest-builder --name <contest_name>
This will create the necessary directories and files for each problem in the contest, using the provided templates. You can specify the details of the contest by passing other options as well. The list of all options are as follow:
--provider <site_provider>
You need to specify the website that provides the contest in the config file first. There are some default values as well likecodeforces
andleetcode
.--problem_cnt <problem_count>
Specify the number of problems.--language <programming_language>
Specify the language you are using at this contest if it differs from the default value.--name_type <folders_name_type>
It can bealphabetical
,numerical
, orroman
.
For example you want to create a codeforces contest with 8 problems, using python language. in order to do this, you can simply write:
contest-builder --name "Codeforces Round 938 (Div. 3)" --problem_cnt 8 --language py --provider cf
You can set your desired abbreviations for languages and contest providers in the cb-config
.
To compile and run a solution for a specific problem, use the contest-builder command with the --run option:
contest-builder --run <problem_name>
This will detect the language you've chosen to write the code, and then
compiles and executes the solution based on the way it's provided in the
cb-config
. If you are located in the
problem's folder, you can discard the <problem_name>
and just pass the --run
option.
Example:
contest-builder --run a
You can also create the folder and file structure for a single problem using the contest-builder command with the --problem
option:
contest-builder --problem --name <problem_name>
This will generate the necessary files and directories for the specified problem.
Example:
contest-builder --problem --name "Random Problem" --language seepp --provider lc
it will generate leetcode/problemset/random-problem/random-problem.cpp
and it's
corresponding input as well.
Contest Builder allows you to customize templates for generating solution files. You can modify these templates according to your
preferences by editing the template files located in the templates
directory or adding the new ones for other languages.
Also you need to edit the compile
and run
sections in the config file as you wish.
Contributions are welcome! If you have any ideas for improvements or new features, feel free to open an issue or submit a pull request.
Contest Builder is licensed under the MIT License. See the LICENSE file for details.