Skip to content

Commit 7ef480a

Browse files
authored
Update README.md
1 parent 5787e21 commit 7ef480a

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,31 +23,33 @@ This allows to work with python interact within VSCode and utilize Github copilo
2323
Now the Python extension installation will automatically install Pytest on your environment. All you need to do is just configure Pytest. Follow the below steps to configure Pytest.
2424
Click the flask icon on the left tool bar. You can find this once you open a repository that contains Python unit tests.
2525
Now click on “Configure Python Tests”, select pytest and the test code library
26-
2726
After configuring Pytest, VS Code will automatically discover your Unit Tests. You can customise which folder to look for tests in the settings under "python.testing.cwd" parameter in the .vscode/settings.json file.
27+
2828
## Installing requests
2929
* To download and install requests, run this command from the terminal : pip install requests
3030

3131
## Settting up virtual environment
32-
Pytest works best in virtual environments when using in VSCode. A virtual environment  is a built-in way to create an environment. A virtual environment creates a folder that contains a copy (or symlink) to a specific interpreter. When you install packages into a virtual environment it will end up in this new folder, and thus isolated from other packages used by other workspaces.
32+
Pytest is particularly effective in virtual environments when VSCode is utilized. A virtual environment is a way to create an environment that is built-in. A folder is created by a virtual environment that contains a copy to a specific interpreter. Installing packages in a virtual environment will result in a new folder that is isolated from other packages used by other workspaces.
3333
Working in virtual environments-
3434
Pyenv is a library to work with different python environments-
3535
* brew install pyenv
3636
* pyenv install 3.13
3737

3838
## Add libraries to be used in the package to requirements.txt :
39-
**Set up requirements.txt for required packages**
39+
**Set up requirements.txt for required packages**
4040

41-
* [pydantic](https://docs.pydantic.dev/latest/) - Data validation library for python
42-
* requests - To get data from APIs
43-
* [pytest](https://docs.pytest.org/en/stable/) - python testing library
44-
* jsonschema :
45-
* pytest-html:
46-
* pytest-cov:
47-
* pre-commit:
41+
* [pydantic](https://docs.pydantic.dev/latest/) - Data validation library for python
42+
* requests - To get data from APIs
43+
* [pytest](https://docs.pytest.org/en/stable/) - python testing library
44+
* jsonschema : to enable json structure for python
45+
* pytest-html : plugin for pytest to generate HTML report for results
46+
* pytest-cov : pytest plugin to render coverage reports.
47+
* pre-commit : maange pre commit hooks
4848

49-
*  pip install -r requirements.txt
49+
To install the set up: pip install -r requirements.txt
5050

5151
## Report view in VScode in TEST RESULTS :
52+
The report view provides report after execution of tests in TEST RESULTS tab in VScode. The results are in html format using pytest-html format of report structure woth pytest-cov that gives stats on test execution and code coverage at the end of each run.
53+
5254

5355

0 commit comments

Comments
 (0)