Feature/improve factories and docs (#6)

* Add file registry
* Add shell command to Makefile
* Improve Django factories
* Improve tests
* Add to documentation

.gitignore

@@ -39,3 +39,4 @@ local_settings.py
 examples/pydantic/media/
 examples/tortoise/media/
 examples/django/media/
+examples/dataclasses/media/

.secrets.baseline

@@ -118,16 +118,16 @@
         "filename": "Makefile",
         "hashed_secret": "ee783f2421477b5483c23f47eca1f69a1f2bf4fb",
         "is_verified": true,
-        "line_number": 44
+        "line_number": 59
       },
       {
         "type": "Secret Keyword",
         "filename": "Makefile",
         "hashed_secret": "1457a35245051927fac6fa556074300f4162ed66",
         "is_verified": true,
-        "line_number": 47
+        "line_number": 62
       }
     ]
   },
-  "generated_at": "2023-11-25T00:02:19Z"
+  "generated_at": "2023-12-02T22:21:04Z"
 }

CHANGELOG.rst

@@ -16,6 +16,14 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.3
+---
+2023-12-03
+
+- Added factories.
+- Added mechanism to clean-up (remove) the created test files.
+- Improved documentation.
+
 0.2
 ---
 2023-12-01

Makefile

@@ -1,5 +1,5 @@
 # Update version ONLY here
-VERSION := 0.2
+VERSION := 0.3
 SHELL := /bin/bash
 # Makefile for project
 VENV := ~/.virtualenvs/fake.py/bin/activate
@@ -40,6 +40,21 @@ install:
 test:
 	source $(VENV) && pytest -vrx -s
 
+shell:
+	source $(VENV) && ipython
+
+django-shell:
+	source $(VENV) && python examples/django/manage.py shell
+
+pydantic-shell:
+	source $(VENV) && python examples/pydantic/shell.py
+
+dataclasses-shell:
+	source $(VENV) && python examples/dataclasses/shell.py
+
+tortoise-shell:
+	source $(VENV) && python examples/tortoise/shell.py
+
 create-secrets:
 	source $(VENV) && detect-secrets scan > .secrets.baseline
 
@@ -48,11 +63,11 @@ detect-secrets:
 
 # Clean up generated files
 clean:
-	find . -name "*.pyc" -exec rm -rf {} \;
-	find . -name "builddocs.zip" -exec rm -rf {} \;
-	find . -name "*.py,cover" -exec rm -rf {} \;
-	find . -name "*.orig" -exec rm -rf {} \;
-	find . -name "__pycache__" -exec rm -rf {} \;
+	find . -type f -name "*.pyc" -exec rm -f {} \;
+	find . -type f -name "builddocs.zip" -exec rm -f {} \;
+	find . -type f -name "*.py,cover" -exec rm -f {} \;
+	find . -type f -name "*.orig" -exec rm -f {} \;
+	find . -type d -name "__pycache__" -exec rm -rf {} \; -prune
 	rm -rf build/
 	rm -rf dist/
 	rm -rf .cache/