chore: docs and benchmarks

Author: aminalaee

benchmarks/README.md

@@ -3,65 +3,66 @@
 import uuid_utils
 
 node = uuid.getnode()
+iterations = 10_000
 
 
 def uuid_uuid1() -> None:
-    for _ in range(10_000):
+    for _ in range(iterations):
         uuid.uuid1(node)
 
 
 def uuid_utils_uuid1() -> None:
-    for _ in range(10_000):
+    for _ in range(iterations):
         uuid_utils.uuid1(node)
 
 
 def uuid_uuid3() -> None:
-    for _ in range(10_000):
+    for _ in range(iterations):
         uuid.uuid3(namespace=uuid.NAMESPACE_DNS, name="python.org")
 
 
 def uuid_utils_uuid3() -> None:
-    for _ in range(10_000):
+    for _ in range(iterations):
         uuid_utils.uuid3(namespace=uuid_utils.NAMESPACE_DNS, name="python.org")
 
 
 def uuid_uuid4() -> None:
-    for _ in range(10_000):
+    for _ in range(iterations):
         uuid.uuid4()
 
 
 def uuid_utils_uuid4() -> None:
-    for _ in range(10_000):
+    for _ in range(iterations):
         uuid_utils.uuid4()
 
 
 def uuid_uuid5() -> None:
-    for _ in range(10_000):
+    for _ in range(iterations):
         uuid.uuid5(namespace=uuid.NAMESPACE_DNS, name="python.org")
 
 
 def uuid_utils_uuid5() -> None:
-    for _ in range(10_000):
+    for _ in range(iterations):
         uuid_utils.uuid5(namespace=uuid_utils.NAMESPACE_DNS, name="python.org")
 
 
 def uuid_uuid6() -> None:
-    for _ in range(10_000):
+    for _ in range(iterations):
         uuid.uuid6()
 
 
 def uuid_utils_uuid6() -> None:
-    for _ in range(10_000):
+    for _ in range(iterations):
         uuid_utils.uuid6()
 
 
 def uuid_uuid7() -> None:
-    for _ in range(10_000):
+    for _ in range(iterations):
         uuid.uuid7()
 
 
 def uuid_utils_uuid7() -> None:
-    for _ in range(10_000):
+    for _ in range(iterations):
         uuid_utils.uuid7()
 
 

benchmarks/bench_generator.py

@@ -2,44 +2,46 @@
 
 import uuid_utils
 
+ITERATIONS = 10_000
+
 
 def uuid_from_hex() -> None:
-    for _ in range(10_000):
+    for _ in range(ITERATIONS):
         uuid.UUID("a8098c1a-f86e-11da-bd1a-00112444be1e")
 
 
 def uuid_utils_from_hex() -> None:
-    for _ in range(10_000):
+    for _ in range(ITERATIONS):
         uuid_utils.UUID("a8098c1a-f86e-11da-bd1a-00112444be1e")
 
 
 def uuid_from_bytes() -> None:
-    for _ in range(10_000):
+    for _ in range(ITERATIONS):
         uuid.UUID("a8098c1a-f86e-11da-bd1a-00112444be1e")
 
 
 def uuid_utils_from_bytes() -> None:
-    for _ in range(10_000):
+    for _ in range(ITERATIONS):
         uuid_utils.UUID("a8098c1a-f86e-11da-bd1a-00112444be1e")
 
 
 def uuid_from_int() -> None:
-    for _ in range(10_000):
+    for _ in range(ITERATIONS):
         uuid.UUID("a8098c1a-f86e-11da-bd1a-00112444be1e")
 
 
 def uuid_utils_from_int() -> None:
-    for _ in range(10_000):
+    for _ in range(ITERATIONS):
         uuid_utils.UUID("a8098c1a-f86e-11da-bd1a-00112444be1e")
 
 
 def uuid_from_fields() -> None:
-    for _ in range(10_000):
+    for _ in range(ITERATIONS):
         uuid.UUID(fields=(2819197978, 63598, 4570, 189, 26, 73622928926))
 
 
 def uuid_utils_from_fields() -> None:
-    for _ in range(10_000):
+    for _ in range(ITERATIONS):
         uuid_utils.UUID(fields=(2819197978, 63598, 4570, 189, 26, 73622928926))
 
 

benchmarks/bench_parser.py

@@ -2,9 +2,15 @@
 
 <div align="center">
 
-[![Package version](https://badge.fury.io/py/uuid-utils.svg)](https://pypi.org/project/uuid-utils/)
-[![Supported Python versions](https://img.shields.io/pypi/pyversions/uuid-utils.svg?color=%2334D058)](https://pypi.org/project/uuid-utils)
-[![CodSpeed](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/aminalaee/uuid-utils?utm_source=badge)
+<a href="https://pypi.org/project/uuid-utils/" target="_blank">>
+    <img src="https://badge.fury.io/py/uuid-utils.svg" alt="Package version">
+</a>
+<a href="https://pypi.org/project/uuid-utils" target="_blank">
+    <img src="https://img.shields.io/pypi/pyversions/uuid-utils.svg?color=%2334D058" alt="Supported Python versions">
+</a>
+<a href="https://codspeed.io/aminalaee/uuid-utils?utm_source=badge" target="_blank">
+    <img src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" alt="Codspeed">
+</a>
 
 </div>
 

docs/index.md

@@ -1,5 +1,5 @@
 site_name: UUID-Utils
-site_description: Python bindings to Rust UUID
+site_description: Fast, drop-in replacement for Python's uuid module, powered by Rust.
 site_url: https://aminalaee.github.io/uuid-utils
 
 theme:
@@ -39,7 +39,5 @@ extra:
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/aminalaee
-    - icon: fontawesome/brands/twitter
-      link: https://twitter.com/aminalaee
     - icon: fontawesome/brands/linkedin
-      link: https://www.linkedin.com/in/amin-alaee
+      link: https://www.linkedin.com/in/amin-alaee

mkdocs.yml

@@ -4,3 +4,4 @@ mypy==1.19.0
 pytest==9.0.1
 pytest-codspeed==4.2.0
 ruff==0.14.7
+richbench==1.0.3