Merge pull request #262 from glensc/test-deps

Taxel · Apr 18, 2021 · 1863851 · 1863851
2 parents fb33483 + 45e3453
commit 1863851
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1 +1,4 @@
 *.py text=auto diff=python
+/.gitattributes export-ignore
+/.github/ export-ignore
+/tests/ export-ignore
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -41,6 +41,29 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
 [issues]: https://github.com/Taxel/PlexTraktSync/issues
 [opening a new issue]: https://github.com/Taxel/PlexTraktSync/issues/new
 
+## Testing
+
+We use [pytest] for testing.
+
+First, ensure you have dependencies installed:
+```
+pip3 install -r tests/requirements.txt
+```
+
+To run all tests:
+
+```
+python3 -m pytest
+```
+
+To run specific test:
+
+```
+python3 -m pytest tests/test_version.py
+```
+
+[pytest]: https://pytest.org/
+
 ## Sharing Plex Media Server Database
 
 Sometimes it is useful to share your copy of your Plex Media Server database

diff --git a/tests/requirements.txt b/tests/requirements.txt
@@ -0,0 +1,2 @@
+-r ../requirements.txt
+pytest