typeid-python 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

typeid/__init__.py

@@ -1,3 +1,3 @@
-from .typeid import TypeID, from_string, from_uuid
+from .typeid import TypeID, from_string, from_uuid, get_prefix_and_suffix
 
-__all__ = ("TypeID", "from_string", "from_uuid")
+__all__ = ("TypeID", "from_string", "from_uuid", "get_prefix_and_suffix")

typeid/base32.py

@@ -1,3 +1,5 @@
+from typing import List
+
 from typeid.constants import SUFFIX_LEN
 
 ALPHABET = "0123456789abcdefghjkmnpqrstvwxyz"
@@ -263,7 +265,7 @@ TABLE = [
 ]
 
 
-def encode(src: list) -> str:
+def encode(src: List[int]) -> str:
     dst = [""] * SUFFIX_LEN
 
     if len(src) != 16:
@@ -302,7 +304,7 @@ def encode(src: list) -> str:
     return "".join(dst)
 
 
-def decode(s: str) -> list:
+def decode(s: str) -> List[int]:
     v = bytes(s, encoding="utf-8")
 
     if (

typeid/cli.py

@@ -0,0 +1,42 @@
+from typing import Optional
+
+import click
+from uuid6 import UUID
+
+from typeid import TypeID, base32, from_uuid, get_prefix_and_suffix
+
+
+@click.group()
+def cli():
+    pass
+
+
+@cli.command()
+@click.option("-p", "--prefix")
+def new(prefix: Optional[str] = None) -> None:
+    typeid = TypeID(prefix=prefix)
+    click.echo(str(typeid))
+
+
+@cli.command()
+@click.argument("uuid")
+@click.option("-p", "--prefix")
+def encode(uuid: str, prefix: Optional[str] = None) -> None:
+    typeid = from_uuid(suffix=UUID(uuid), prefix=prefix)
+    click.echo(str(typeid))
+
+
+@cli.command()
+@click.argument("encoded")
+def decode(encoded: str) -> None:
+    prefix, suffix = get_prefix_and_suffix(encoded)
+
+    decoded_bytes = bytes(base32.decode(suffix))
+    uuid = UUID(bytes=decoded_bytes)
+
+    click.echo(f"type: {prefix}")
+    click.echo(f"uuid: {uuid}")
+
+
+if __name__ == "__main__":
+    cli()

typeid/typeid.py

@@ -18,6 +18,16 @@ class TypeID:
         self._prefix = prefix or ""
         self._suffix = suffix
 
+    @classmethod
+    def from_string(cls, string: str):
+        prefix, suffix = get_prefix_and_suffix(string=string)
+        return cls(suffix=suffix, prefix=prefix)
+
+    @classmethod
+    def from_uuid(cls, suffix: UUID, prefix: Optional[str] = None):
+        suffix_str = _convert_uuid_to_b32(suffix)
+        return TypeID(suffix=suffix_str, prefix=prefix)
+
     @property
     def suffix(self) -> str:
         return self._suffix
@@ -26,6 +36,10 @@ class TypeID:
     def prefix(self) -> str:
         return self._prefix
 
+    @property
+    def uuid(self) -> UUID:
+        return _convert_b32_to_uuid(self.suffix)
+
     def __str__(self) -> str:
         value = ""
         if self.prefix:
@@ -38,22 +52,38 @@ class TypeID:
             return False
         return value.prefix == self.prefix and value.suffix == self.suffix
 
+    def __hash__(self) -> int:
+        return hash((self.prefix, self.suffix))
+
 
 def from_string(string: str) -> TypeID:
-    parts = string.split("_")
+    """Consider TypeID.from_string instead."""
+    return TypeID.from_string(string=string)
 
+
+def from_uuid(suffix: UUID, prefix: Optional[str] = None) -> TypeID:
+    """Consider TypeID.from_uuid instead."""
+    return TypeID.from_uuid(suffix=suffix, prefix=prefix)
+
+
+def get_prefix_and_suffix(string: str) -> tuple:
+    parts = string.split("_")
+    suffix = None
+    prefix = None
     if len(parts) == 1:
-        return TypeID(suffix=parts[0])
+        suffix = parts[0]
     elif len(parts) == 2 and parts[0] != "":
-        return TypeID(suffix=parts[1], prefix=parts[0])
+        suffix = parts[1]
+        prefix = parts[0]
     else:
         raise InvalidTypeIDStringException(f"Invalid TypeID: {string}")
 
-
-def from_uuid(suffix: UUID, prefix: Optional[str] = None) -> TypeID:
-    suffix_str = _convert_uuid_to_b32(suffix)
-    return TypeID(suffix=suffix_str, prefix=prefix)
+    return prefix, suffix
 
 
 def _convert_uuid_to_b32(uuid_instance: UUID) -> str:
     return base32.encode(list(uuid_instance.bytes))
+
+
+def _convert_b32_to_uuid(b32: str) -> UUID:
+    return UUID(bytes=bytes(base32.decode(b32)))

{typeid_python-0.2.0.dist-info → typeid_python-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: typeid-python
-Version: 0.2.0
+Version: 0.2.2
 Summary: Python implementation of TypeIDs: type-safe, K-sortable, and globally unique identifiers inspired by Stripe IDs
 Home-page: https://github.com/akhundMurad/typeid-python
 License: MIT
@@ -16,6 +16,7 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Provides-Extra: cli
 Requires-Dist: uuid6 (>=2023.5.2,<2024.0.0)
 Project-URL: Repository, https://github.com/akhundMurad/typeid-python
 Description-Content-Type: text/markdown
@@ -48,18 +49,20 @@ This particular implementation provides an pip package that can be used by any P
 
 - PyPI:
 
-    ```bash
+    ```console
     pip install typeid-python
     ```
 
 - Poetry:
 
-    ```bash
+    ```console
     poetry add typeid-python
     ```
 
 ## Usage
 
+### Basic
+
 - Create TypeID Instance:
 
     ```python
@@ -79,9 +82,9 @@ This particular implementation provides an pip package that can be used by any P
 - Create TypeID from string:
 
     ```python
-    from typeid import from_string
+    from typeid import TypeID
 
-    typeid = from_string("user_01h45ytscbebyvny4gc8cr8ma2")
+    typeid = TypeID.from_string("user_01h45ytscbebyvny4gc8cr8ma2")
 
     print(str(typeid))  # "user_01h45ytscbebyvny4gc8cr8ma2"
     ```
@@ -89,14 +92,44 @@ This particular implementation provides an pip package that can be used by any P
 - Create TypeID from uuid7:
 
     ```python
-    from typeid import from_uuid
+    from typeid import TypeID
     from uuid6 import uuid7
 
     uuid = uuid7()  # UUID('01890bf0-846f-7762-8605-5a3abb40e0e5')
     prefix = "user"
 
-    typeid = from_uuid(prefix=prefix, suffix=uuid)
+    typeid = TypeID.from_uuid(prefix=prefix, suffix=uuid)
 
     print(str(typeid))  # "user_01h45z113fexh8c1at7axm1r75"
     ```
 
+### CLI-tool
+
+- Install dependencies:
+
+    ```console
+    pip install typeid-python[cli]
+    ```
+
+- To generate a new TypeID, run:
+
+    ```console
+    $ python3 -m typeid.cli new -p prefix
+    prefix_01h2xcejqtf2nbrexx3vqjhp41
+    ```
+
+- To decode an existing TypeID into a UUID run:
+
+    ```console
+    $ python3 -m typeid.cli decode prefix_01h2xcejqtf2nbrexx3vqjhp41
+    type: prefix
+    uuid: 0188bac7-4afa-78aa-bc3b-bd1eef28d881
+    ```
+
+- And to encode an existing UUID into a TypeID run:
+
+    ```console
+    $ python3 -m typeid.cli encode 0188bac7-4afa-78aa-bc3b-bd1eef28d881 --prefix prefix
+    prefix_01h2xcejqtf2nbrexx3vqjhp41
+    ```
+

typeid_python-0.2.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+typeid/__init__.py,sha256=bS8J12-a6sOcTIHBumVs9qLRxCX5P-KWVLeMw6m1e_U,149
+typeid/base32.py,sha256=UTYXJjb95_nn-vYIpw7nquguBac4GZ0TL0oE6BuujPg,6504
+typeid/cli.py,sha256=h93_EAOzWO3bqubgL83Q-smHp11lvxMjgAunwyTWwFM,872
+typeid/constants.py,sha256=2ApV0agNys2yI9NM8oQZbyTR2rgP-VtxXGrM6glBB2Q,37
+typeid/errors.py,sha256=QPHZ-DJg5OpPOHtuetsqMCYu-E_aHMJZTTeFqx9Gz_4,207
+typeid/typeid.py,sha256=_hu8bHjFVcwe2QklrFmYZOj2ycltuL8p_XjAq2ncviY,2480
+typeid/validation.py,sha256=yvLO5lfMkJpduZzql_FJlj4hW6HcWURWYLRQvR92SSM,899
+typeid_python-0.2.2.dist-info/LICENSE,sha256=f98oZ9FId4i3835UJYGw066BU8PSc57L1utGWS1ypcs,1070
+typeid_python-0.2.2.dist-info/METADATA,sha256=RDsPvAGyBmrLMR0cCxu0-6ZvuOjKSJ_ndX227zSftcY,4073
+typeid_python-0.2.2.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+typeid_python-0.2.2.dist-info/RECORD,,

{typeid_python-0.2.0.dist-info → typeid_python-0.2.2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.6.1
+Generator: poetry-core 1.7.0
 Root-Is-Purelib: true
 Tag: py3-none-any

typeid_python-0.2.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-typeid/__init__.py,sha256=Xq1_XIJtLlxK0Nv4YXx6jJ5owUL7YSmHxBQA8Pd4-AY,101
-typeid/base32.py,sha256=rPDHs0p66stn9VA82NkpSzBCjm93ILGso09zEPjlMwc,6469
-typeid/constants.py,sha256=2ApV0agNys2yI9NM8oQZbyTR2rgP-VtxXGrM6glBB2Q,37
-typeid/errors.py,sha256=QPHZ-DJg5OpPOHtuetsqMCYu-E_aHMJZTTeFqx9Gz_4,207
-typeid/typeid.py,sha256=q79bFYCydq7mjYOA_OKOGv0oFZ60TMHdshR2It7Kcyk,1660
-typeid/validation.py,sha256=yvLO5lfMkJpduZzql_FJlj4hW6HcWURWYLRQvR92SSM,899
-typeid_python-0.2.0.dist-info/LICENSE,sha256=f98oZ9FId4i3835UJYGw066BU8PSc57L1utGWS1ypcs,1070
-typeid_python-0.2.0.dist-info/METADATA,sha256=EteNUmTOcsHAjXV1ug2srkjFS21b9m0Zm8_Drmu6ZZg,3385
-typeid_python-0.2.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-typeid_python-0.2.0.dist-info/RECORD,,