diff --git a/README.md b/README.md index 888a8c5..0920fd3 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ workflows. This tool is on PyPI. To install, please run: ```bash -$ pip install fixml +pip install fixml ``` ## Usage @@ -88,16 +88,16 @@ such as specifying a checklist file, output format, and verbosity. Example calls: ```bash # Evaluate repo, and output the evalutions as a JSON file in working directory -$ fixml evaluate /path/to/your/repo +fixml evaluate /path/to/your/repo # Perform the above verbosely, and use the JSON file to export a HTML report -$ fixml evaluate /path/to/your/repo -e ./eval_report.html -v +fixml evaluate /path/to/your/repo -e ./eval_report.html -v # Perform the above, but use a custom checklist, and to overwrite existing report -$ fixml evaluate /path/to/your/repo -e ./eval_report.html -v -o -c checklist/checklist.csv +fixml evaluate /path/to/your/repo -e ./eval_report.html -v -o -c checklist/checklist.csv # Perform the above, and to use gpt-4o as the evaluation model -$ fixml evaluate /path/to/your/repo -e ./eval_report.html -v -o -c checklist/checklist.csv -m gpt-4o +fixml evaluate /path/to/your/repo -e ./eval_report.html -v -o -c checklist/checklist.csv -m gpt-4o ``` #### Test Spec Generator @@ -109,10 +109,10 @@ the test specification generation process. Example calls: ```bash # Generate test function specifications and to write them into a .py file -$ fixml generate test.py +fixml generate test.py # Perform the above, but to use a custom checklist -$ fixml generate test.py -c checklist/checklist.csv +fixml generate test.py -c checklist/checklist.csv ``` ### Package @@ -139,25 +139,25 @@ on [their official website](https://docs.anaconda.com/miniconda/). 1. Clone this repository from GitHub: ```bash -$ git clone git@github.com:UBC-MDS/fixml.git +git clone git@github.com:UBC-MDS/fixml.git ``` 2. Create a conda environment: ```bash -$ conda env create -f environment.yaml +conda env create -f environment.yaml ``` 3. Activate the newly created conda environment (default name `fixml`): ```bash -$ conda activate fixml +conda activate fixml ``` 4. Use `poetry` which is preinstalled in the conda environment to create a local package install: ```bash -$ poetry install +poetry install ``` 5. You now should be able to run `fixml`, try: @@ -182,10 +182,10 @@ to run the test suite: ```bash # skip integration tests -$ pytest -m "not integeration" +pytest -m "not integeration" # run ALL tests, which requires OPENAI_API_KEY to be set -$ pytest +pytest ``` ## Contributing