Issue-361 : Implement Caching with Redis

backend/REDIS_IMPLEMENTATION.md

@@ -0,0 +1,9 @@
+# Redis Implementation
+
+This file is meant to document the potential one day addition of [Redis](https://redis.io/) to the activist backend. At time of creation, the team decided that adding in Redis is an extra service that we don't have capacity to maintain. The plan is to add it at some point, but only after simpler performance improvements have been implemented and exhausted.
+
+An initial change that's needed is that [django-redis](https://github.com/jazzband/django-redis) should be added to the backend dependencies by adding it to [backend/requirements.in](./requirements.in) and [backend/requirements-dev.in](./requirements-dev.in). The commands within those files are then ran to add it to the respective `.txt` files.
+
+## File Changes
+
+Please see [#1163](https://github.com/activist-org/activist/pull/1163) where adding [Redis](https://redis.io/) to the backend was first done. The changes in that PR would be the basis of an eventual addition of [Redis](https://redis.io/).

backend/content/tests/tests.py

@@ -31,6 +31,7 @@ def test_str_methods() -> None:
     assert str(task) == task.name
     assert str(topics) == topics.name
 
+
 def test_discussion_str_method():
     """Test the __str__ method of the Discussion model."""
     user = UserFactory()
@@ -42,6 +43,7 @@ def test_discussion_str_method():
     )
     assert str(discussion) == f"{discussion.id}"
 
+
 def test_faq_str_method():
     """Test the __str__ method of the Faq model."""
     faq = Faq(
@@ -55,6 +57,7 @@ def test_faq_str_method():
     )
     assert str(faq) == faq.question
 
+
 def test_image_str_method():
     """Test the __str__ method of the Image model."""
     image_id = uuid4()
@@ -64,6 +67,7 @@ def test_image_str_method():
     )
     assert str(image) == f"{image_id}"
 
+
 def test_location_str_method():
     """Test the __str__ method of the Location model."""
     location_id = uuid4()
@@ -75,6 +79,7 @@ def test_location_str_method():
     )
     assert str(location) == f"{location_id}"
 
+
 def test_social_link_str_method():
     """Test the __str__ method of the SocialLink model."""
     social_link = SocialLink(
@@ -87,6 +92,7 @@ def test_social_link_str_method():
     )
     assert str(social_link) == social_link.label
 
+
 def test_tag_str_method():
     """Test the __str__ method of the Tag model."""
     tag_id = uuid4()
@@ -98,6 +104,7 @@ def test_tag_str_method():
     )
     assert str(tag) == f"{tag_id}"
 
+
 def test_discussion_entry_str_method():
     """Test the __str__ method of the DiscussionEntry model."""
     user = UserFactory()

backend/core/settings.py

@@ -94,6 +94,7 @@
 
 ROOT_URLCONF = "core.urls"
 
+
 # MARK: Templates
 
 TEMPLATES = [

backend/events/tests.py

@@ -5,7 +5,6 @@
 
 # mypy: ignore-errors
 import pytest
-
 from events.factories import (
     EventFactory,
     EventAttendeeFactory,
@@ -31,6 +30,7 @@ def test_str_methods() -> None:
     assert str(_format) == _format.name
     assert str(role) == role.name
 
+
 def test_event_text_str_method() -> None:
     event = EventFactory.create()
     event_text = EventText.objects.create(

backend/requirements-dev.txt

@@ -187,7 +187,6 @@ virtualenv==20.28.1
     # via pre-commit
 wheel==0.45.1
     # via pip-tools
-
 # The following packages are considered to be unsafe in a requirements file:
 # pip
 # setuptools