Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Glenn Jocher <[email protected]>
  • Loading branch information
glenn-jocher authored Jan 17, 2025
1 parent 55c7f40 commit 6108c81
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# Tests Directory (`tests/`)

This directory houses the tests for our project, primarily using pytest for testing.
This directory houses the tests for our project, providing two options for running tests: using **pytest** or **unittest**.

## Overview

Expand All @@ -13,9 +13,28 @@ This directory houses the tests for our project, primarily using pytest for test

## Running Tests

To execute the tests:
### Option 1: Using `pytest` (Recommended)

1. **Install pytest:** Ensure pytest is installed in your environment.
2. **Run Tests:** Execute `pytest` in the root directory of the project.
1. **Install pytest:**
```bash
pip install pytest
```
2. **Run Tests:**
```bash
python -m pytest tests -v
```

### Option 2: Using `unittest` (No Additional Dependencies)

If you'd prefer to avoid external dependencies, you can use Python's built-in `unittest` framework:

1. **Run Tests:**
```bash
python -m unittest discover tests -v
```

### Notes
- `pytest` offers more advanced features and better readability, making it the recommended choice.
- `unittest` is built into Python and eliminates the need for additional installations, providing a lightweight alternative.

Make sure to regularly run tests to maintain the reliability and quality of the project.

0 comments on commit 6108c81

Please sign in to comment.