From c6e8f5052e5e0c5b1317b3171a43f3e4a49ef40d Mon Sep 17 00:00:00 2001 From: ryansurf Date: Tue, 28 May 2024 21:21:31 -0700 Subject: [PATCH 1/2] test path update in contributing.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f8e08b2..20dcbc9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ To run black: **Testing** -To run tests, install pytest, `pip install pytest` and navigate to `src/test`. +To run tests, install pytest, `pip install pytest` and navigate to `/test`. Run `pytest` From c13fda19f0d3d4c2e952fd93b25185d5111a8b62 Mon Sep 17 00:00:00 2001 From: ryansurf Date: Tue, 28 May 2024 21:27:01 -0700 Subject: [PATCH 2/2] docs test path update --- docs/structure.md | 26 ++++++++++++++------------ docs/tests.md | 4 ++-- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/structure.md b/docs/structure.md index 54ab900..a2e74a7 100644 --- a/docs/structure.md +++ b/docs/structure.md @@ -6,9 +6,10 @@ The basic structure of the project is: ├── docs ├── images ├── src - ├── static - ├── templates - └── tests +│ ├── __pycache__ +│ ├── static +│ └── templates +├── tests ``` - `docs`: Contains markdown for the documentation (this website!) @@ -16,7 +17,7 @@ The basic structure of the project is: - `src`: Source code! - `src/static`: JavaScript - `src/templates`: HTML - - `src/tests`: Testing files +- `tests`: Testing files @@ -30,6 +31,7 @@ More in-depth structure: │ ├── index.md │ ├── install.md │ ├── setup.md +│ ├── structure.md │ ├── styling.md │ └── tests.md ├── help.txt @@ -39,6 +41,7 @@ More in-depth structure: │ ├── wave.png │ └── website.gif ├── mkdocs.yml +├── pyproject.toml ├── README.md ├── requirements.txt ├── src @@ -47,15 +50,14 @@ More in-depth structure: │ ├── cli.py │ ├── helper.py │ ├── __init__.py +│ ├── __pycache__ │ ├── send_email.py │ ├── server.py │ ├── static -│ │ └── script.js -│ ├── templates -│ │ └── index.html -│ └── tests -│ ├── __init__.py -│ └── test_code.py +│ └── templates ├── start_venv.sh -└── venv -``` \ No newline at end of file +├── tests + ├── __init__.py + └── test_code.py +``` + diff --git a/docs/tests.md b/docs/tests.md index 5fa68b7..30c1ef1 100644 --- a/docs/tests.md +++ b/docs/tests.md @@ -1,6 +1,6 @@ # Tests -To run tests, install pytest, `pip install pytest` and navigate to `src/test`. +To run tests, install pytest, `pip install pytest` and navigate to `/test`. Run `pytest` @@ -8,7 +8,7 @@ On a push/pull request, git will run `pytest` for you to catch any errors. ## Writing Tests -In `src/tests`, there are multiple files for different types of test cases. +In `/tests`, there are multiple files for different types of test cases. - `test_helper.py`: Tests functions in `src/helper.py` (functions like rounding decimals, etc.) - `test_api.py`: Tests functions in `src/api.py`.