testcase-maker 0.3.0.post0
Competitive programming testcases made easy!
License: MIT License
Requires Python: >=3.8

# Testcase Maker

[![Downloads](https://static.pepy.tech/personalized-badge/testcase-maker?period=total&units=international_system&left_color=grey&right_color=lightgrey&left_text=Downloads)](https://pepy.tech/project/testcase-maker)
[![pypi](https://img.shields.io/pypi/v/testcase-maker)](https://pypi.org/project/testcase-maker/)
[![docs](https://img.shields.io/readthedocs/testcase-maker)](https://testcase-maker.readthedocs.io/en/stable/)
[![python](https://img.shields.io/pypi/pyversions/testcase-maker)](https://www.python.org/)
[![license](https://img.shields.io/github/license/benwoo1110/testcase-maker)](https://github.com/benwoo1110/testcase-maker/blob/main/LICENSE)

### Competitive programming testcases made easy!

## About
**\*\*NOTE:  The library is a work-in-progress, there may be breaking changes.**

When creating competitive programming challenges, we will also need to create testcases. These testcases may be very 
large with millions of numbers, which makes it near impossible to do manually. This library will allow you to automate 
this process. It provides an intuitive API to build, generate and validate testcases. 

#### **Testcase Maker** aims to be:

* Very modular and expandable API structure
* Fast and efficient
* Extensive documentation and examples

#### **Testcase Maker** is feature-packed with:

* Highly customisable values to suit large range of challenges
* Separate constraints for subtasks
* Execute answer scripts in java, cpp or python to get stdout

## Installation
This lib is hosted on pypi, thus you can install this lib by typing the following line:
```
pip install testcase-maker
```

## Basics Usage
You can get started generating testcases with just a few lines of code. Here is a simple example of generating testcases 
with N number of random integers, i.
```python
import logging

from testcase_maker.generator import TestcaseGenerator
from testcase_maker.values import ValueGroup, NamedValue, RandomInt, LoopValue, ValueRef

logging.basicConfig(level=logging.INFO)

values = ValueGroup()
# Define the N value.
values.add(NamedValue(name="N", value=RandomInt(min=50, max=1000)))
values.newline()
# Define the N number of integers.
values.add(LoopValue(
    value=NamedValue(name="i", value=RandomInt(min=1, max=1000)),
    amount=ValueRef("N"),
    delimiter=" ",
))

# Generate stdin testcases
generator = TestcaseGenerator(values=values)
generator.generate_stdin()
```

Some challenges has subtasks with testcases requiring different constraints. Continuing from the previous example, here 
is how you can do it with **Testcase Maker**.
```python
# ...replacing generator code from the simple example...
# Generate stdin testcases
generator = TestcaseGenerator(values=values)

# Reduce the range of both N and i values.
easy = generator.new_subtask(no_of_testcase=2)
easy.override_value(name="N", value=RandomInt(min=2, max=5))
easy.override_value(name="i", value=RandomInt(min=1, max=100))

# Reduce the range of N. Slightly harder but still less than default.
medium = generator.new_subtask(no_of_testcase=2)
medium.override_value(name="N", value=RandomInt(min=6, max=50))

# Using default constraints. This will generate the largest set of testcases.
hard = generator.new_subtask(no_of_testcase=2)

generator = TestcaseGenerator(values=values)
generator.generate_stdin()
```

Apart from stdin, you can also generate stdout with an answer script. 
```python
# ...replacing generator code from the simple example...
# Generate stdin and stdout testcases
generator = TestcaseGenerator(values=values, answer_script="./solutions.py")
generator.generate()
```

```python
# solution.py
N = int(input())
numbers = [int(x) for x in input().split()]
numbers.sort()
print(" ".join([str(x) for x in numbers]))
```

## Advanced
There are still so many other things you can do with this library. For more advanced and detailed usage guide, please refer to 
the [official documentation](https://testcase-maker.readthedocs.io/en/stable/)!

## License
This project is license with MIT. Read full details at [LICENSE](LICENSE) file.