Skip to content
This repository has been archived by the owner on Dec 1, 2024. It is now read-only.

Commit

Permalink
chore: Updated dependencies to incluse pytest-cov for coverage report
Browse files Browse the repository at this point in the history
  • Loading branch information
dikayx committed Aug 19, 2024
1 parent 710bee8 commit c30cf2e
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ htmlcov/
docs/\_build/
.DS_Store
.pytest*/
*.pem
*.pem
.coverage
23 changes: 23 additions & 0 deletions docs/TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,26 @@ pytest
This will run all the tests in the `tests` directory and output the results in the terminal. If all tests pass, you should see a message indicating that all tests have passed successfully.

That's it! You are now ready to contribute to the project by adding new features, fixing bugs, or improving the existing codebase. If you have any questions or need help with anything, feel free to [open an issue](https://github.com/dan-koller/mapy/issues) or reach out to me directly.

## Coverage

Currently, the test coverage of the project is around 90%. This means that 90% of the codebase is covered by the tests. To check the test coverage of the project, you can run the following command:

```bash
pytest --cov=mapy tests/
```

This results in an output like this:

```
---------- coverage: platform darwin, python 3.12.4-final-0 ----------
Name Stmts Miss Cover
------------------------------------------------
mapy/__init__.py 0 0 100%
mapy/app.py 21 0 100%
mapy/context_processors.py 21 5 76%
mapy/routes.py 16 2 88%
mapy/utils.py 192 17 91%
------------------------------------------------
TOTAL 250 24 90%
```
3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ requests~=2.32.3
beautifulsoup4~=4.12.3
geoip2~=4.8.0
IPy~=1.1
pytest~=8.3.1
pytest~=8.3.1
pytest-cov==5.0.0

0 comments on commit c30cf2e

Please sign in to comment.