ramifice 0.3.25__py3-none-any.whl → 0.3.26__py3-none-any.whl

ramifice/utilities.py

@@ -29,13 +29,17 @@ def to_human_size(size: int) -> str:
 
 
 def get_file_size(path: str) -> int:
-    """Get human readable version of file size."""
+    """Get file size in bytes."""
     size: int = os.path.getsize(path)
     return size
 
 
 def normal_email(email: str | None) -> str | None:
-    """Normalizing email address."""
+    """Normalizing email address.
+    
+    Use this before requeste to a database.
+    For example, on the login page.
+    """
     normal: str | None = None
     try:
         emailinfo = validate_email(str(email), check_deliverability=False)

{ramifice-0.3.25.dist-info → ramifice-0.3.26.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ramifice
-Version: 0.3.25
+Version: 0.3.26
 Summary: ORM-like API MongoDB for Python language.
 Project-URL: Homepage, https://github.com/kebasyaty/ramifice
 Project-URL: Documentation, https://kebasyaty.github.io/ramifice/
@@ -513,7 +513,7 @@ await user.delete(remove_files=False)
 # Verification, replacement and recoverang of password.
 user = User()
 await user.verify_password(password="12345678")
-await user.update_password(  # uses verify_password
+await user.update_password(  # + verify_password
   old_password="12345678",
   new_password="O2eA4GIr38KGGlS",
 )
@@ -536,34 +536,47 @@ from ramifice.utilities import (
     to_human_size,
 )
 
+# Validate Password.
 if is_password("12345678"):
     ...
 
+# Validate Email address.
 if is_email("kebasyaty@gmail.com"):
     ...
 
-email = normal_email("kebasyaty@gmail.com")  # + validate_email
+# Normalizing email address.
+# Use this before requeste to a database.
+# For example, on the login page.
+email: str | None = normal_email("kebasyaty@gmail.com")  # None, if not valid
 
+# Validate URL address.
 if is_url("https://www.google.com"):
     ...
 
+# Validate IP address.
 if is_ip("127.0.0.1"):
     ...
 
+# Validate Color code.
 if is_color("#000"):
     ...
 
+# Validate Phone number.
 if is_phone("+447986123456"):
     ...
 
+# Validation of the Mongodb identifier.
 if is_mongo_id("666f6f2d6261722d71757578"):
     ...
 
+# Get ObjectId from hash string.
 from bson.objectid import ObjectId
 _id: ObjectId | None = hash_to_obj_id("666f6f2d6261722d71757578")
 
+# Convert number of bytes to readable format.
 size: str = to_human_size(2097152)  # => 2.0 MB
 
+# Get file size in bytes.
 path = "public/media/default/no_doc.odt"
 size: int = get_file_size(path)  # => 9843
 ```

{ramifice-0.3.25.dist-info → ramifice-0.3.26.dist-info}/RECORD

@@ -13,7 +13,7 @@ ramifice/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ramifice/store.py,sha256=MpDEPvUvbs11FXjakNtHPm9MekIv5p1U3as2Y80lTyc,1860
 ramifice/translations.py,sha256=GNGE0ULAA0aOY5pTxUd3MQW-nVaKvp6BeXWEcsR0s0o,4048
 ramifice/types.py,sha256=ljo6VscUGWEJ4Km4JYo8GEfxd1YK1CUbS8CfHp_MlEA,2390
-ramifice/utilities.py,sha256=2qfdSvqlL3rhT8-7MW83IoMjKQ0CZz0e24UTxMcOq90,2654
+ramifice/utilities.py,sha256=NX4mtXBi6H3UNlYcTMdlfltJ0MikTPa7kpB3F0qmUpM,2731
 ramifice/commons/__init__.py,sha256=LHCsdpl4z8W-xUvAlOr1ad0ras9hspvCpuce4SAdfP0,472
 ramifice/commons/general.py,sha256=fTnIRA3IGbi0lMKBCgeqkI7BGJWTbZVu0nOJYoNRSRU,4571
 ramifice/commons/indexes.py,sha256=ABNRXeWZSreAE4_EDlsTN9aS8QiZbzhsatUJFn2EuOo,3849
@@ -76,7 +76,7 @@ ramifice/paladins/groups/num_group.py,sha256=lpyFG9a6WGOzu9f_9jwYVWZNFHxG0B0AVWv
 ramifice/paladins/groups/pass_group.py,sha256=tjBSovPSCKATF46FazT0a1EQ2YiztRqOjBq0uu2nTU8,1852
 ramifice/paladins/groups/slug_group.py,sha256=SVYxHcSSgCA51C18LVGxMQYuUw-6ryQlTi6B9T8Dzsw,2185
 ramifice/paladins/groups/text_group.py,sha256=o5DnlptN93vsHtb36qO-noEnPv7CSAiqVj1j603zKw0,3159
-ramifice-0.3.25.dist-info/METADATA,sha256=RCix9UrN67JO5bCxjhQ4lgWYtiX-RlQJHzm7erzuuN8,20303
-ramifice-0.3.25.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ramifice-0.3.25.dist-info/licenses/LICENSE,sha256=LrEL0aTZx90HDwFUQCJutORiDjJL9AnuVvCtspXIqt4,1095
-ramifice-0.3.25.dist-info/RECORD,,
+ramifice-0.3.26.dist-info/METADATA,sha256=RtWfTYrINWsELm_ilRSn8MYrv4He6xvlKJ9ete4zMT4,20706
+ramifice-0.3.26.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ramifice-0.3.26.dist-info/licenses/LICENSE,sha256=LrEL0aTZx90HDwFUQCJutORiDjJL9AnuVvCtspXIqt4,1095
+ramifice-0.3.26.dist-info/RECORD,,