Merge pull request #81 from barseghyanartur/dev

Docs/improve docs (#80)

.secrets.baseline

@@ -118,14 +118,14 @@
         "filename": "Makefile",
         "hashed_secret": "504a5c3a2ce5fa0acc5f8d9685dc45860c25a8ed",
         "is_verified": true,
-        "line_number": 283
+        "line_number": 235
       },
       {
         "type": "Secret Keyword",
         "filename": "Makefile",
         "hashed_secret": "a3dd3453449ace4d9d2320fa941a909b57c0e846",
         "is_verified": true,
-        "line_number": 286
+        "line_number": 238
       }
     ],
     "README.rst": [
@@ -219,5 +219,5 @@
       }
     ]
   },
-  "generated_at": "2024-09-10T21:44:07Z"
+  "generated_at": "2024-10-30T22:52:46Z"
 }

Makefile

@@ -48,32 +48,20 @@ compile_requirements:
 	echo "dev.in"
 	pip-compile examples/requirements/dev.in
 
-	echo "django_2_2.in"
-	pip-compile examples/requirements/django_2_2.in
+	echo "django_5_0.in"
+	pip-compile examples/requirements/django_5_0.in
 
-	echo "django_3_2.in"
-	pip-compile examples/requirements/django_3_2.in
-
-	echo "django_4_0.in"
-	pip-compile examples/requirements/django_4_0.in
-
-	echo "django_4_1.in"
-	pip-compile examples/requirements/django_4_1.in
+	echo "django_5_1.in"
+	pip-compile examples/requirements/django_5_1.in
 
 	echo "django_4_2.in"
 	pip-compile examples/requirements/django_4_2.in
 
-	echo "django_2_2_and_flask.in"
-	pip-compile examples/requirements/django_2_2_and_flask.in
-
-	echo "django_3_2_and_flask.in"
-	pip-compile examples/requirements/django_3_2_and_flask.in
-
-	echo "django_4_0_and_flask.in"
-	pip-compile examples/requirements/django_4_0_and_flask.in
+	echo "django_5_0_and_flask.in"
+	pip-compile examples/requirements/django_5_0_and_flask.in
 
-	echo "django_4_1_and_flask.in"
-	pip-compile examples/requirements/django_4_1_and_flask.in
+	echo "django_5_1_and_flask.in"
+	pip-compile examples/requirements/django_5_1_and_flask.in
 
 	echo "django_4_2_and_flask.in"
 	pip-compile examples/requirements/django_4_2_and_flask.in
@@ -109,32 +97,20 @@ compile_requirements_upgrade:
 	echo "dev.in"
 	pip-compile --upgrade examples/requirements/dev.in
 
-	echo "django_2_2.in"
-	pip-compile --upgrade examples/requirements/django_2_2.in
+	echo "django_5_0.in"
+	pip-compile --upgrade examples/requirements/django_5_0.in
 
-	echo "django_3_2.in"
-	pip-compile --upgrade examples/requirements/django_3_2.in
-
-	echo "django_4_0.in"
-	pip-compile --upgrade examples/requirements/django_4_0.in
-
-	echo "django_4_1.in"
-	pip-compile --upgrade examples/requirements/django_4_1.in
+	echo "django_5_1.in"
+	pip-compile --upgrade examples/requirements/django_5_1.in
 
 	echo "django_4_2.in"
 	pip-compile --upgrade examples/requirements/django_4_2.in
 
-	echo "django_2_2_and_flask.in"
-	pip-compile --upgrade examples/requirements/django_2_2_and_flask.in
-
-	echo "django_3_2_and_flask.in"
-	pip-compile --upgrade examples/requirements/django_3_2_and_flask.in
-
-	echo "django_4_0_and_flask.in"
-	pip-compile --upgrade examples/requirements/django_4_0_and_flask.in
+	echo "django_5_0_and_flask.in"
+	pip-compile --upgrade examples/requirements/django_5_0_and_flask.in
 
-	echo "django_4_1_and_flask.in"
-	pip-compile --upgrade examples/requirements/django_4_1_and_flask.in
+	echo "django_5_1_and_flask.in"
+	pip-compile --upgrade examples/requirements/django_5_1_and_flask.in
 
 	echo "django_4_2_and_flask.in"
 	pip-compile --upgrade examples/requirements/django_4_2_and_flask.in
@@ -170,32 +146,20 @@ uv_compile_requirements:
 	echo "dev.in"
 	uv pip compile --no-strip-extras examples/requirements/dev.in -o examples/requirements/dev.txt
 
-	echo "django_2_2.in"
-	uv pip compile --no-strip-extras examples/requirements/django_2_2.in -o examples/requirements/django_2_2.txt
+	echo "django_5_0.in"
+	uv pip compile --no-strip-extras examples/requirements/django_5_0.in -o examples/requirements/django_5_0.txt
 
-	echo "django_3_2.in"
-	uv pip compile --no-strip-extras examples/requirements/django_3_2.in -o examples/requirements/django_3_2.txt
-
-	echo "django_4_0.in"
-	uv pip compile --no-strip-extras examples/requirements/django_4_0.in -o examples/requirements/django_4_0.txt
-
-	echo "django_4_1.in"
-	uv pip compile --no-strip-extras examples/requirements/django_4_1.in -o examples/requirements/django_4_1.txt
+	echo "django_5_1.in"
+	uv pip compile --no-strip-extras examples/requirements/django_5_1.in -o examples/requirements/django_5_1.txt
 
 	echo "django_4_2.in"
 	uv pip compile --no-strip-extras examples/requirements/django_4_2.in -o examples/requirements/django_4_2.txt
 
-	echo "django_2_2_and_flask.in"
-	uv pip compile --no-strip-extras examples/requirements/django_2_2_and_flask.in -o examples/requirements/django_2_2_and_flask.txt
-
-	echo "django_3_2_and_flask.in"
-	uv pip compile --no-strip-extras examples/requirements/django_3_2_and_flask.in -o examples/requirements/django_3_2_and_flask.txt
-
-	echo "django_4_0_and_flask.in"
-	uv pip compile --no-strip-extras examples/requirements/django_4_0_and_flask.in -o examples/requirements/django_4_0_and_flask.txt
+	echo "django_5_0_and_flask.in"
+	uv pip compile --no-strip-extras examples/requirements/django_5_0_and_flask.in -o examples/requirements/django_5_0_and_flask.txt
 
-	echo "django_4_1_and_flask.in"
-	uv pip compile --no-strip-extras examples/requirements/django_4_1_and_flask.in -o examples/requirements/django_4_1_and_flask.txt
+	echo "django_5_1_and_flask.in"
+	uv pip compile --no-strip-extras examples/requirements/django_5_1_and_flask.in -o examples/requirements/django_5_1_and_flask.txt
 
 	echo "django_4_2_and_flask.in"
 	uv pip compile --no-strip-extras examples/requirements/django_4_2_and_flask.in -o examples/requirements/django_4_2_and_flask.txt
@@ -231,32 +195,20 @@ uv_compile_requirements_upgrade:
 	echo "dev.in"
 	uv pip compile --upgrade --no-strip-extras examples/requirements/dev.in -o examples/requirements/dev.txt
 
-	echo "django_2_2.in"
-	uv pip compile --upgrade --no-strip-extras examples/requirements/django_2_2.in -o examples/requirements/django_2_2.txt
+	echo "django_5_0.in"
+	uv pip compile --upgrade --no-strip-extras examples/requirements/django_5_0.in -o examples/requirements/django_5_0.txt
 
-	echo "django_3_2.in"
-	uv pip compile --upgrade --no-strip-extras examples/requirements/django_3_2.in -o examples/requirements/django_3_2.txt
-
-	echo "django_4_0.in"
-	uv pip compile --upgrade --no-strip-extras examples/requirements/django_4_0.in -o examples/requirements/django_4_0.txt
-
-	echo "django_4_1.in"
-	uv pip compile --upgrade --no-strip-extras examples/requirements/django_4_1.in -o examples/requirements/django_4_1.txt
+	echo "django_5_1.in"
+	uv pip compile --upgrade --no-strip-extras examples/requirements/django_5_1.in -o examples/requirements/django_5_1.txt
 
 	echo "django_4_2.in"
 	uv pip compile --upgrade --no-strip-extras examples/requirements/django_4_2.in -o examples/requirements/django_4_2.txt
 
-	echo "django_2_2_and_flask.in"
-	uv pip compile --upgrade --no-strip-extras examples/requirements/django_2_2_and_flask.in -o examples/requirements/django_2_2_and_flask.txt
-
-	echo "django_3_2_and_flask.in"
-	uv pip compile --upgrade --no-strip-extras examples/requirements/django_3_2_and_flask.in -o examples/requirements/django_3_2_and_flask.txt
-
-	echo "django_4_0_and_flask.in"
-	uv pip compile --upgrade --no-strip-extras examples/requirements/django_4_0_and_flask.in -o examples/requirements/django_4_0_and_flask.txt
+	echo "django_5_0_and_flask.in"
+	uv pip compile --upgrade --no-strip-extras examples/requirements/django_5_0_and_flask.in -o examples/requirements/django_5_0_and_flask.txt
 
-	echo "django_4_1_and_flask.in"
-	uv pip compile --upgrade --no-strip-extras examples/requirements/django_4_1_and_flask.in -o examples/requirements/django_4_1_and_flask.txt
+	echo "django_5_1_and_flask.in"
+	uv pip compile --upgrade --no-strip-extras examples/requirements/django_5_1_and_flask.in -o examples/requirements/django_5_1_and_flask.txt
 
 	echo "django_4_2_and_flask.in"
 	uv pip compile --upgrade --no-strip-extras examples/requirements/django_4_2_and_flask.in -o examples/requirements/django_4_2_and_flask.txt

README.rst

@@ -105,7 +105,7 @@ a few are `BSD`-, `Apache 2`-, `GPL` or `HPND` licensed.
 
 All licenses are mentioned below between the brackets.
 
-- Core package requires Python 3.7, 3.8, 3.9, 3.10 or 3.11.
+- Core package requires Python 3.9, 3.10 or 3.11.
 - `Faker`_ (`MIT`) is the only required dependency.
 - `Django`_ (`BSD`) integration with `factory_boy`_ (`MIT`) has
   been tested with ``Django`` starting from version 2.2 to 4.2 (although only

docs/test_docs.py

@@ -60,6 +60,7 @@ def execute_file(file_path, caplog):
         exec(code, global_vars)
 
 
+@pytest.mark.flaky(retries=3, delay=1)
 @pytest.mark.django_db
 @pytest.mark.parametrize("file_path", py_files)
 @override_settings(AWS_STORAGE_BUCKET_NAME="testing")

examples/requirements/dev.txt

@@ -80,28 +80,28 @@ defusedxml==0.7.1
     # via odfpy
 distlib==0.3.8
     # via virtualenv
-django==3.2.25
+django==4.2.16
     # via
-    #   -r examples/requirements/django_3_2.in
+    #   -r examples/requirements/django_4_2.in
     #   django-debug-toolbar
     #   django-extensions
     #   django-storages
     #   djangorestframework
     #   drf-spectacular
 django-debug-toolbar==4.3.0
-    # via -r examples/requirements/django_3_2.in
+    # via -r examples/requirements/django_4_2.in
 django-extensions==3.2.3
-    # via -r examples/requirements/django_3_2.in
+    # via -r examples/requirements/django_4_2.in
 django-storages==1.13.2
-    # via -r examples/requirements/django_3_2.in
-djangorestframework==3.12.4
+    # via -r examples/requirements/django_4_2.in
+djangorestframework==3.15.2
     # via
-    #   -r examples/requirements/django_3_2.in
+    #   -r examples/requirements/django_4_2.in
     #   drf-spectacular
 docutils==0.21.2
     # via readme-renderer
 drf-spectacular==0.27.2
-    # via -r examples/requirements/django_3_2.in
+    # via -r examples/requirements/django_4_2.in
 edge-tts==6.1.12
     # via -r examples/requirements/common.in
 et-xmlfile==1.1.0
@@ -324,9 +324,7 @@ python-levenshtein==0.25.1
 python-pptx==1.0.2
     # via -r examples/requirements/common.in
 pytz==2024.1
-    # via
-    #   -r examples/requirements/common.in
-    #   django
+    # via -r examples/requirements/common.in
 pyyaml==6.0.2
     # via
     #   drf-spectacular