Suppress warnings in tests and add instructions for testing in README. Update .gitignore.

Author: nbecker-yc

.gitignore

@@ -11,3 +11,4 @@ build/
 .coverage
 **/htmlcov/**
 dist/*
+.python-version

README.md

@@ -47,7 +47,6 @@ class Incrementer:
 #### How to invalidate a cache
 
 ```python
-
 foo(1)
 foo.invalidate(1)
 
@@ -61,6 +60,30 @@ Incrementer.get_datetime()
 Incrementer.get_datetime.invalidate()
 ```
 
+#### How to run tests
+
+1. Create and activate a new Python virtual environment using the package manager of your choice (e.g., `pyenv-virtualenv`, `virtualenv`, etc.).
+
+2. Install requirements. 
+
+    ```bash
+    pip install -r requirements.txt
+    ```
+   
+3. Install the `django_cache_helper` package in editable mode
+
+    ```bash
+    pip install -e .
+    ```
+   
+4. Run tests using `manage.py`: 
+
+    ```bash
+    cd test_project
+    python manage.py test
+    ```
+
+Note that the current test suite generates some expected warnings, which are manually suppressed in the test code. 
 
 ## Contributors ✨
 

test_project/test_project/tests.py

@@ -1,14 +1,15 @@
+import logging
+from datetime import datetime
 from unittest.mock import patch
 
-from django.test import TestCase
 from django.core.cache import cache
+from django.test import TestCase
 
 from cache_helper.decorators import cached, cached_class_method, cached_instance_method
 from cache_helper.exceptions import CacheHelperException, CacheKeyCreationError
 from cache_helper.interfaces import CacheHelperCacheable
 
-from datetime import datetime
-
+DISABLE_LOGGING_BELOW = logging.ERROR
 GLOBAL_COUNTER = 200
 
 
@@ -112,9 +113,15 @@ def get_product(self):
 
 
 class CachedInstanceMethodTests(TestCase):
+
+    def setUp(self):
+        logging.disable(DISABLE_LOGGING_BELOW)
+        super().setUp()
+
     def tearDown(self):
         super().tearDown()
         cache.clear()
+        logging.disable(logging.NOTSET)
 
     def test_exception_during_cache_retrieval(self):
         incrementer = Incrementer(100)
@@ -272,6 +279,11 @@ def test_invalidate_instance_method(self):
 
 
 class CachedClassMethodTests(TestCase):
+
+    def setUp(self):
+        logging.disable(DISABLE_LOGGING_BELOW)
+        super().setUp()
+
     def tearDown(self):
         super().tearDown()
 
@@ -281,6 +293,7 @@ def tearDown(self):
         AnotherIncrementer.class_counter = 500
 
         cache.clear()
+        logging.disable(logging.NOTSET)
 
     def test_exception_during_cache_retrieval(self):
         # Hasn't been computed before, so the function actually gets called
@@ -414,12 +427,17 @@ def test_invalidate_class_method(self):
 
 
 class CachedStaticMethodTests(TestCase):
+    def setUp(self):
+        logging.disable(DISABLE_LOGGING_BELOW)
+        super().setUp()
+
     def tearDown(self):
         super().tearDown()
 
         global GLOBAL_COUNTER
         GLOBAL_COUNTER = 200
         cache.clear()
+        logging.disable(logging.NOTSET)
 
     def test_exception_during_cache_retrieval(self):
         datetime_1 = Incrementer.get_datetime(1)