test_creation

To be filled

Installation

1. Create a conda environment using environment.yml in the repo:

conda env create -f environment.yml

2. Activate the newly created conda environment (default name test-creation):

conda activate test-creation

3. In the conda environment, poetry should be installed. Use Poetry to install the package:

poetry install

4. add .env with API key attached:

echo "OPENAI_API_KEY=..." > .env

5. Enjoy! This package comes will an executable test-creation and a bunch of scripts. Here are some examples:

# evaluate a repository and write a HTML report, display verbose messages
test-creation evaluate $REPO_PATH ./report.html --verbose

# export checklist items into a PDF, overwrite file if exists in the specified path
test-creation checklist export checklist.pdf --overwrite

Usage

code_analyzer

This is used to analyze and extract information from a downloaded repo.

There is a file containing the example calls. Run:

$ python ./src/code_analyzer/example.py <path-to-your-repo>

Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

test_creation was created by John Shiu, Orix Au Yeung, Tony Shum, Yingzi Jin. It is licensed under the terms of the MIT license.

Credits

test_creation was created with cookiecutter and the py-pkgs-cookiecutter template.