typeid-python 0.3.5__tar.gz

typeid_python-0.3.5/.gitignore

@@ -0,0 +1,314 @@
+# Created by https://www.toptal.com/developers/gitignore/api/venv,python,visualstudiocode,pycharm
+# Edit at https://www.toptal.com/developers/gitignore?templates=venv,python,visualstudiocode,pycharm
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### PyCharm Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+# Azure Toolkit for IntelliJ plugin
+# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
+.idea/**/azureSettings.xml
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+### venv ###
+# Virtualenv
+# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
+[Bb]in
+[Ii]nclude
+[Ll]ib
+[Ll]ib64
+[Ll]ocal
+[Ss]cripts
+pyvenv.cfg
+pip-selfcheck.json
+
+### VisualStudioCode ###
+.vscode/
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/venv,python,visualstudiocode,pycharm
+
+.DS_Store

typeid_python-0.3.5/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Murad Akhundov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

typeid_python-0.3.5/PKG-INFO

@@ -0,0 +1,247 @@
+Metadata-Version: 2.4
+Name: typeid-python
+Version: 0.3.5
+Summary: Python implementation of TypeIDs: type-safe, K-sortable, and globally unique identifiers inspired by Stripe IDs
+Project-URL: Homepage, https://github.com/akhundMurad/typeid-python
+Project-URL: Repository, https://github.com/akhundMurad/typeid-python
+Project-URL: Bug Tracker, https://github.com/akhundMurad/typeid-python/issues
+Author-email: Murad Akhundov <akhundov1murad@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: guid,typeid,uuid,uuid6
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: <4,>=3.10
+Requires-Dist: uuid6<2026.0.0,>=2024.7.10
+Provides-Extra: cli
+Requires-Dist: click; extra == 'cli'
+Provides-Extra: rust
+Requires-Dist: uuid-utils>=0.12.0; extra == 'rust'
+Provides-Extra: yaml
+Requires-Dist: pyyaml; extra == 'yaml'
+Description-Content-Type: text/markdown
+
+# TypeID Python
+
+[![Run Tests](https://github.com/akhundMurad/typeid-python/actions/workflows/test.yml/badge.svg)](https://github.com/akhundMurad/typeid-python/actions/workflows/test.yml)
+[![PyPI Downloads](https://static.pepy.tech/personalized-badge/typeid-python?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/typeid-python)
+[![PyPI - Version](https://img.shields.io/pypi/v/typeid-python?color=green)](https://pypi.org/project/typeid-python/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/typeid-python?color=green)](https://pypi.org/project/typeid-python/)
+
+
+A **high-performance Python implementation of [TypeIDs](https://github.com/jetpack-io/typeid)** — type-safe,
+sortable identifiers based on **UUIDv7**.
+
+TypeIDs are designed for modern systems where identifiers should be:
+
+- globally unique
+- sortable by creation time
+- safe to expose externally
+- easy to reason about in logs, APIs, and databases
+
+This library provides a Python package with optional Rust acceleration.
+
+## Key features
+
+- ✅ UUIDv7-based, time-sortable identifiers
+- ✅ Type-safe prefixes (`user_`, `order_`, …)
+- ✅ Human-readable and URL-safe
+- ✅ Fast generation & parsing (Rust-accelerated)
+- ✅ CLI tools (`new`, `encode`, `decode`, `explain`)
+- ✅ Schema-based ID explanations (JSON / YAML)
+- ✅ Fully offline, no external services
+
+## Performance
+
+TypeID is optimized for **real-world performance**, not just correctness.
+
+### Benchmark summary (mean time)
+
+| Operation | Before Rust | Rust + optimizations |
+| --------- | ----------- | -------------------- |
+| Generate  | 3.47 µs     | **0.70 µs**          |
+| Parse     | 2.08 µs     | **1.30 µs**          |
+| Workflow  | 5.52 µs     | **2.25 µs**          |
+
+### Highlights
+
+* 🚀 **~5× faster generation**
+* ⚡ **~1.6× faster parsing**
+* 🔁 **~2.5× faster end-to-end workflows**
+
+Benchmarks are:
+
+* reproducible
+* committed as raw JSON
+* runnable locally via `bench/`
+
+See [`Docs: Performance`](https://akhundmurad.github.io/typeid-python/performance/) for details.
+
+## Installation
+
+### Core (pure Python)
+
+```console
+$ pip install typeid-python
+```
+
+### With Rust acceleration (recommended)
+
+```console
+$ pip install typeid-python[rust]
+```
+
+This enables:
+
+* Rust base32 encode/decode
+* `uuid-utils` for fast UUIDv7 generation
+
+If Rust is unavailable, TypeID automatically falls back to the pure-Python implementation.
+
+### Other optional extras
+
+```console
+$ pip install typeid-python[yaml]   # YAML schema support
+$ pip install typeid-python[cli]    # CLI tools
+```
+
+Extras are **strictly optional**.
+
+## Usage
+
+### Basic
+
+```python
+from typeid import TypeID
+
+tid = TypeID(prefix="user")
+
+assert tid.prefix == "user"
+assert isinstance(tid.suffix, str)
+assert str(tid).startswith("user_")
+```
+
+### From string
+
+```python
+from typeid import TypeID
+
+tid = TypeID.from_string("user_01h45ytscbebyvny4gc8cr8ma2")
+assert tid.prefix == "user"
+```
+
+### From UUIDv7
+
+```python
+from typeid import TypeID
+from uuid6 import uuid7
+
+u = uuid7()
+tid = TypeID.from_uuid(prefix="user", suffix=u)
+
+assert tid.uuid.version == 7
+```
+
+### Typed prefixes
+
+```python
+from typing import Literal
+from typeid import TypeID, typeid_factory
+
+UserID = TypeID[Literal["user"]]
+gen_user_id = typeid_factory("user")
+
+user_id = gen_user_id()
+```
+
+## CLI
+
+```console
+$ pip install typeid-python[cli]
+```
+
+Generate:
+
+```console
+$ typeid new -p user
+user_01h2xcejqtf2nbrexx3vqjhp41
+```
+
+Decode:
+
+```console
+$ typeid decode user_01h2xcejqtf2nbrexx3vqjhp41
+uuid: 0188bac7-4afa-78aa-bc3b-bd1eef28d881
+```
+
+Encode:
+
+```console
+$ typeid encode 0188bac7-4afa-78aa-bc3b-bd1eef28d881 --prefix user
+```
+
+## ✨ `typeid explain` — understand any ID
+
+```console
+$ typeid explain user_01h45ytscbebyvny4gc8cr8ma2
+```
+
+Outputs:
+
+```yaml
+parsed:
+  prefix: user
+  uuid: 01890bf0-846f-7762-8605-5a3abb40e0e5
+  created_at: 2025-03-12T10:41:23Z
+  sortable: true
+```
+
+Works **without schema**, fully offline.
+
+## Schema-based explanations
+
+Define meaning for prefixes using JSON or YAML.
+
+Example (`typeid.schema.json`):
+
+```json
+{
+  "schema_version": 1,
+  "types": {
+    "user": {
+      "name": "User",
+      "owner_team": "identity-platform",
+      "pii": true
+    }
+  }
+}
+```
+
+Then:
+
+```console
+$ typeid explain user_01h45ytscbebyvny4gc8cr8ma2
+```
+
+Read more here: ["Docs: Explain"](https://akhundmurad.github.io/typeid-python/performance/).
+
+## Design principles
+
+* **Non-breaking**: stable APIs
+* **Optional acceleration**: Rust is opt-in
+* **Lazy evaluation**: work is done only when needed
+* **Explainability**: identifiers carry meaning
+* **Transparency**: performance claims are backed by data
+
+> Think of TypeID as
+> **UUIDs + semantics + observability — without sacrificing speed**
+
+## License
+
+MIT