Merge remote-tracking branch 'origin/main'

Author: lukbrew25

.github/workflows/minlinter.yml

@@ -39,4 +39,4 @@ jobs:
         find . -name '.pytest_cache' -delete
         find . -name '.coverage' -delete
         find . -name 'coverage.xml' -delete
-        find . -name 'htmlcov' -type d -exec rm -rf {} +
+        find . -name 'htmlcov' -type d -exec rm -rf {} +

CONTRIBUTING.md

@@ -4,6 +4,8 @@ First off, thanks for taking the time to contribute!
 
 All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
 
+This project also participates in Hacktoberfest, so your contributions will count towards your pull request total.
+
 > And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
 > - Star the project
 > - Tweet about it

README.md

@@ -503,6 +503,29 @@ import easy_mongodb_auth_handler as emdb
   - **Returns:**
     - `bool`: `True` if the email format is valid, `False` otherwise.
 
+- **emdb.hash_password(password)**
+  - Hashes a password.
+  - **Parameters:**
+    - `password` (`str`): The password to hash.
+  - **Returns:**
+    - `str`: The hashed password.
+
+- **emdb.check_password(user, password)**
+  - Checks a un-hashed password against the hashed password stored in the user document.
+  - **Parameters:**
+    - `user` (`dict`): The user document to authenticate.
+    - `password` (`str`): The un-hashed password to check against the user document.
+  - **Returns:**
+    - `bool`: `True` if the passwords match and `False` otherwise.
+
+- **emdb.verify_password(password, hashed)**
+  - Checks a un-hashed password against the hashed password passed as a parameter.
+  - **Parameters:**
+    - `password` (`dict`): The un-hashed password to check.
+    - `hashed` (`str`): The hashed password to check.
+  - **Returns:**
+    - `bool`: `True` if the passwords match and `False` otherwise.
+
 ## Requirements
 
 - Python >= 3.9

src/easy_mongodb_auth_handler/__init__.py

@@ -7,4 +7,5 @@
 from .utils import Utils
 from .core_db import CoreDB
 from .package_functions.message import get_messages
-from .package_functions.func import generate_secure_code, get_version, validate_email
+from .package_functions.func import (generate_secure_code, get_version, validate_email,
+                                     check_password, hash_password, verify_password)