lastuuid 0.1.1__tar.gz → 0.2.1__tar.gz

{lastuuid-0.1.1 → lastuuid-0.2.1}/.github/workflows/build-wheels.yml

@@ -75,11 +75,11 @@ jobs:
 
           - os: windows
             target: x86_64
-            interpreter: 3.11 3.12 3.13
+            interpreter: 3.10 3.11 3.12 3.13
           - os: windows
             target: i686
             python-architecture: x86
-            interpreter: 3.11 3.12 3.13
+            interpreter: 3.10 3.11 3.12 3.13
         exclude:
           # Exclude failed build
           - os: windows

lastuuid-0.2.1/.github/workflows/publish-doc.yml

@@ -0,0 +1,30 @@
+name: Doc
+
+on:
+  workflow_call:
+    inputs:
+      release-version:
+        required: true
+        type: string
+      dry-run:
+        required: true
+        type: boolean
+
+  workflow_dispatch:
+
+jobs:
+  pages:
+    runs-on: ubuntu-20.04
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write # Grants write access for GitHub Pages
+      id-token: write # Enables id-token for OIDC tokens
+    steps:
+      - id: deployment
+        uses: sphinx-notes/pages@v3
+        with:
+          documentation_path: docs/source
+          publish: ${{ !inputs.dry-run }}
+          python_version: 3.12

{lastuuid-0.1.1 → lastuuid-0.2.1}/.github/workflows/release.yml

@@ -84,3 +84,15 @@ jobs:
       dry-run: ${{ needs.plan.outputs.dry-run == 'true' }}
     secrets:
       PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+
+  publish-doc:
+    needs:
+      - plan
+      - tests-artifacts
+    uses: ./.github/workflows/publish-doc.yml
+    with:
+      release-version: ${{ needs.plan.outputs.release_version }}
+      dry-run: ${{ needs.plan.outputs.dry-run == 'true' }}
+    permissions:
+      id-token: write
+      pages: write

{lastuuid-0.1.1 → lastuuid-0.2.1}/.github/workflows/tests.yml

@@ -27,7 +27,7 @@ jobs:
         uses: astral-sh/setup-uv@v3
 
       - name: Install the project
-        run: uv sync
+        run: uv sync --group dev
 
       - name: Build tarball
         run: uv build

lastuuid-0.2.1/CHANGELOG.md

@@ -0,0 +1,15 @@
+## 0.2.1  -  2025-02-15
+
+* Add more utilities in the API, such as {func}`lastuuid.uuid7_to_datetime`,
+{func}`lastuuid.utils.uuid7_bounds_from_date`,
+{func}`lastuuid.utils.uuid7_bounds_from_datetime`
+* Build a documentation available at https://mardiros.github.io/lastuuid/
+
+## 0.1.2  -  2024-12-14
+
+* Build library for windows / python 3.10 for x64 and i686 architecture
+* Update readme
+
+## 0.1.1  -  2024-11-10
+
+* Initial release

{lastuuid-0.1.1 → lastuuid-0.2.1}/Cargo.lock

@@ -51,7 +51,7 @@ checksum = "b248f5224d1d606005e02c97f5aa4e88eeb230488bcc03bc9ca4d7991399f2b5"
 
 [[package]]
 name = "lastuuid"
-version = "0.1.1"
+version = "0.2.1"
 dependencies = [
  "pyo3",
  "uuid7",

{lastuuid-0.1.1 → lastuuid-0.2.1}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "lastuuid"
-version = "0.1.1"
+version = "0.2.1"
 authors = ["Guillaume Gauvrit <guillaume@gauvr.it>"]
 edition = "2021"
 description = "Yest another UUID library."

{lastuuid-0.1.1 → lastuuid-0.2.1}/Justfile

@@ -4,7 +4,15 @@ develop:
     uv run maturin develop
 
 install:
-    uv sync
+    uv sync --group dev --group docs
+
+doc:
+    cd docs && uv run make html
+    xdg-open docs/build/html/index.html
+
+cleandoc:
+    rm -rf docs/build
+    rm -rf docs/source/develop
 
 test testsuite=default_testsuite: develop
     uv run pytest -sxv {{testsuite}}
@@ -12,10 +20,13 @@ test testsuite=default_testsuite: develop
 lf:
     uv run pytest --lf -vvv
 
+fmt:
+    uv run ruff check --fix .
+    uv run ruff format src tests
 
 release major_minor_patch: && changelog
     #!/bin/bash
-    cargo release patch --no-confirm --no-tag --no-push --no-publish --execute
+    cargo release {{major_minor_patch}} --no-confirm --no-tag --no-push --no-publish --execute
     git reset --soft HEAD^
     export VERSION=$(head -n 10 Cargo.toml | grep version | sed 's/.*"\([^"]*\)".*/\1/')
     sed -i "s/version = \"\(.*\)\"/version = \"${VERSION}\"/" pyproject.toml

lastuuid-0.2.1/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: lastuuid
+Version: 0.2.1
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: furo>=2024.5.6 ; extra == 'docs'
+Requires-Dist: linkify-it-py>=2.0.3,<3 ; extra == 'docs'
+Requires-Dist: myst-parser>=3.0.0,<4 ; python_full_version < '3.10' and extra == 'docs'
+Requires-Dist: myst-parser>=4.0.0,<5 ; python_full_version >= '3.10' and extra == 'docs'
+Requires-Dist: sphinx>=7.0.1,<8 ; extra == 'docs'
+Requires-Dist: sphinx-autodoc2>=0.5.0,<1 ; extra == 'docs'
+Provides-Extra: docs
+Summary: Fast UUIDv7 Compatible with standard library type, and utils.
+Keywords: uuid,UUIDv7
+Author: Guillaume Gauvrit <guillaume@gauvr.it>
+Author-email: Guillaume Gauvrit <guillaume@gauvr.it>
+License: MIT License
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/mardiros/lastuuid
+Project-URL: Documentation, https://mardiros.github.io/lastuuid/
+Project-URL: Repository, https://github.com/mardiros/lastuuid.git
+Project-URL: Issues, https://github.com/mardiros/lastuuid/issues
+Project-URL: Changelog, https://mardiros.github.io/lastuuid/changelog.html
+
+# lastuuid - yet another uuid library
+
+[![Documentation](https://github.com/mardiros/lastuuid/actions/workflows/publish-doc.yml/badge.svg)](https://mardiros.github.io/lastuuid/)
+[![Continuous Integration](https://github.com/mardiros/lastuuid/actions/workflows/tests.yml/badge.svg)](https://github.com/mardiros/lastuuid/actions/workflows/tests.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/8e7293fabe7508b2ec6c/maintainability)](https://codeclimate.com/github/mardiros/lastuuid/maintainability)
+
+UUID type is awesome, but, at the moment, the UUID type in the standard library
+does not support the uuid7 format.
+
+You may find plenty of library that implement uuid7, but they have downside,
+such has ignoring pull request to fix issues, or not compatible with Pydantic.
+
+```{note}
+lastuuid is a developer joke based on the nature of UUIDv7,
+
+where the most recently generated UUID is always the last one when sorted.
+```
+
+## Usage
+
+### UUID7
+
+```python
+>>> from lastuuid import uuid7
+>>> uuid7()
+UUID('019316cc-f99a-77b3-89d5-ed8c3cf1f50e')
+```
+
+There is no parameter here, the uuid is generated from the current time.
+
+The implementation of uuid7 algorithm is made in the uuid7 rust crate.
+
+#### Pydantic
+
+This lib has been created because all the other library that implement uuid7
+create there own UUID type, so its not easy to use with pydantic.
+
+```python
+from uuid import UUID
+from pydantic import BaseModel, Field
+
+from lastuuid import uuid7
+
+
+class Dummy(BaseModel):
+    id: UUID = Field(default_factory=uuid7)
+
+```
+
+#### Performance
+
+On my machine the uuid7 is as fast (or slow) as the native uuid4.
+
+```bash
+$ python -m timeit "from lastuuid import uuid7; uuid7()"
+200000 loops, best of 5: 1.8 usec per loop
+
+$ python -m timeit "from uuid import uuid4; uuid4()"
+200000 loops, best of 5: 1.82 usec per loop
+```
+
+### Read More
+
+There are other usefull function in the library that cab be found in the
+[API documentation](https://mardiros.github.io/lastuuid/).
+
+https://mardiros.github.io/lastuuid/
+

{lastuuid-0.1.1 → lastuuid-0.2.1}/README.md

@@ -1,8 +1,21 @@
 # lastuuid - yet another uuid library
 
+[![Documentation](https://github.com/mardiros/lastuuid/actions/workflows/publish-doc.yml/badge.svg)](https://mardiros.github.io/lastuuid/)
+[![Continuous Integration](https://github.com/mardiros/lastuuid/actions/workflows/tests.yml/badge.svg)](https://github.com/mardiros/lastuuid/actions/workflows/tests.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/8e7293fabe7508b2ec6c/maintainability)](https://codeclimate.com/github/mardiros/lastuuid/maintainability)
+
 UUID type is awesome, but, at the moment, the UUID type in the standard library
 does not support the uuid7 format.
 
+You may find plenty of library that implement uuid7, but they have downside,
+such has ignoring pull request to fix issues, or not compatible with Pydantic.
+
+```{note}
+lastuuid is a developer joke based on the nature of UUIDv7,
+
+where the most recently generated UUID is always the last one when sorted.
+```
+
 ## Usage
 
 ### UUID7
@@ -46,25 +59,9 @@ $ python -m timeit "from uuid import uuid4; uuid4()"
 200000 loops, best of 5: 1.82 usec per loop
 ```
 
-### Testing with uuid without brain
+### Read More
 
-Autoincrement your uuid in a test suite avoid some brain pain.
+There are other usefull function in the library that cab be found in the
+[API documentation](https://mardiros.github.io/lastuuid/).
 
-```python
->>> from lastuuid.dummies import uuidgen
->>> uuidgen()
-UUID('00000000-0000-0000-0000-000000000001')
->>> uuidgen()
-UUID('00000000-0000-0000-0000-000000000002')
-```
-
-Or event more readable;
-UUID predicted, where only the first bytes needs to be read.
-
-```python
->>> from lastuuid.dummies import uuidgen
->>> uuidgen(1)
-UUID('00000001-0000-0000-0000-000000000000')
->>> uuidgen(1,2,3,4,5)
-UUID('00000001-0002-0003-0004-000000000005')
-```
+https://mardiros.github.io/lastuuid/

lastuuid-0.2.1/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

lastuuid-0.2.1/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

lastuuid-0.2.1/docs/source/changelog.md

@@ -0,0 +1,5 @@
+# Changelog
+
+
+```{include} ../../CHANGELOG.md
+```

lastuuid-0.2.1/docs/source/conf.py

@@ -0,0 +1,102 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+import tomllib
+
+sys.path.insert(0, os.path.abspath("../../src"))
+
+
+# -- Project information -----------------------------------------------------
+def _get_project_meta():
+    with open("../../pyproject.toml", "rb") as pyproject:
+        return tomllib.load(pyproject)["project"]
+
+
+pkg_meta = _get_project_meta()
+project = str(pkg_meta["name"])
+author = f"{pkg_meta['authors'][0]['name']} <{pkg_meta['authors'][0]['email']}>"
+copyright = f"{pkg_meta['authors'][0]['name']} and contributors"
+
+# The short X.Y version
+version = str(pkg_meta["version"])
+# The full version, including alpha/beta/rc tags
+release = version
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "myst_parser",
+    "autodoc2",
+]
+
+autodoc2_packages = [
+    {"path": "../../lastuuid"},
+]
+
+autodoc2_module_all_regexes = [
+    "lastuuid",
+    r"lastuuid\.utils",
+    r"lastuuid\.dummies",
+]
+
+autodoc2_docstring_parser_regexes = [
+    # this will render all docstrings as Markdown
+    (r".*", "myst"),
+]
+
+autodoc2_hidden_objects = ["undoc", "private", "inherited"]
+autodoc2_render_plugin = "myst"
+
+autodoc2_output_dir = "develop"
+autodoc2_sort_names = True
+
+# Configure MyST parser
+myst_enable_extensions = [
+    "colon_fence",
+    "html_admonition",
+    "html_image",
+    "replacements",
+    "smartquotes",
+    "substitution",
+    "tasklist",
+    "deflist",
+    "fieldlist",
+    "linkify",
+]
+
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "furo"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = []  # "_static"]

lastuuid-0.2.1/docs/source/develop/index.rst

@@ -0,0 +1,11 @@
+API Reference
+=============
+
+This page contains auto-generated API reference documentation [#f1]_.
+
+.. toctree::
+   :titlesonly:
+
+   lastuuid/lastuuid
+
+.. [#f1] Created with `sphinx-autodoc2 <https://github.com/chrisjsewell/sphinx-autodoc2>`_

lastuuid-0.2.1/docs/source/develop/lastuuid/lastuuid.dummies.md

@@ -0,0 +1,34 @@
+# {py:mod}`lastuuid.dummies`
+
+```{py:module} lastuuid.dummies
+```
+
+```{autodoc2-docstring} lastuuid.dummies
+:parser: myst
+:allowtitles:
+```
+
+## Module Contents
+
+### Functions
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`uuidgen <lastuuid.dummies.uuidgen>`
+  - ```{autodoc2-docstring} lastuuid.dummies.uuidgen
+    :parser: myst
+    :summary:
+    ```
+````
+
+### API
+
+````{py:function} uuidgen(i: int = 0, j: int = 0, k: int = 0, x: int = 0, y: int = 0) -> uuid.UUID
+:canonical: lastuuid.dummies.uuidgen
+
+```{autodoc2-docstring} lastuuid.dummies.uuidgen
+:parser: myst
+```
+````

lastuuid-0.2.1/docs/source/develop/lastuuid/lastuuid.lastuuid.md

@@ -0,0 +1,47 @@
+# {py:mod}`lastuuid.lastuuid`
+
+```{py:module} lastuuid.lastuuid
+```
+
+```{autodoc2-docstring} lastuuid.lastuuid
+:parser: myst
+:allowtitles:
+```
+
+## Module Contents
+
+### Functions
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`uuid7 <lastuuid.lastuuid.uuid7>`
+  - ```{autodoc2-docstring} lastuuid.lastuuid.uuid7
+    :parser: myst
+    :summary:
+    ```
+* - {py:obj}`uuid7_to_datetime <lastuuid.lastuuid.uuid7_to_datetime>`
+  - ```{autodoc2-docstring} lastuuid.lastuuid.uuid7_to_datetime
+    :parser: myst
+    :summary:
+    ```
+````
+
+### API
+
+````{py:function} uuid7() -> uuid.UUID
+:canonical: lastuuid.lastuuid.uuid7
+
+```{autodoc2-docstring} lastuuid.lastuuid.uuid7
+:parser: myst
+```
+````
+
+````{py:function} uuid7_to_datetime(uuid7: uuid.UUID, tz=timezone.utc) -> datetime.datetime
+:canonical: lastuuid.lastuuid.uuid7_to_datetime
+
+```{autodoc2-docstring} lastuuid.lastuuid.uuid7_to_datetime
+:parser: myst
+```
+````

lastuuid-0.2.1/docs/source/develop/lastuuid/lastuuid.md

@@ -0,0 +1,47 @@
+# {py:mod}`lastuuid`
+
+```{py:module} lastuuid
+```
+
+```{autodoc2-docstring} lastuuid
+:parser: myst
+:allowtitles:
+```
+
+## Package Contents
+
+### Functions
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`uuid7 <lastuuid.lastuuid.uuid7>`
+  - ```{autodoc2-docstring} lastuuid.lastuuid.uuid7
+    :parser: myst
+    :summary:
+    ```
+* - {py:obj}`uuid7_to_datetime <lastuuid.lastuuid.uuid7_to_datetime>`
+  - ```{autodoc2-docstring} lastuuid.lastuuid.uuid7_to_datetime
+    :parser: myst
+    :summary:
+    ```
+````
+
+### API
+
+````{py:function} uuid7() -> uuid.UUID
+:canonical: lastuuid.lastuuid.uuid7
+
+```{autodoc2-docstring} lastuuid.lastuuid.uuid7
+:parser: myst
+```
+````
+
+````{py:function} uuid7_to_datetime(uuid7: uuid.UUID, tz=timezone.utc) -> datetime.datetime
+:canonical: lastuuid.lastuuid.uuid7_to_datetime
+
+```{autodoc2-docstring} lastuuid.lastuuid.uuid7_to_datetime
+:parser: myst
+```
+````

lastuuid-0.2.1/docs/source/develop/lastuuid/lastuuid.utils.md

@@ -0,0 +1,47 @@
+# {py:mod}`lastuuid.utils`
+
+```{py:module} lastuuid.utils
+```
+
+```{autodoc2-docstring} lastuuid.utils
+:parser: myst
+:allowtitles:
+```
+
+## Module Contents
+
+### Functions
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`uuid7_bounds_from_date <lastuuid.utils.uuid7_bounds_from_date>`
+  - ```{autodoc2-docstring} lastuuid.utils.uuid7_bounds_from_date
+    :parser: myst
+    :summary:
+    ```
+* - {py:obj}`uuid7_bounds_from_datetime <lastuuid.utils.uuid7_bounds_from_datetime>`
+  - ```{autodoc2-docstring} lastuuid.utils.uuid7_bounds_from_datetime
+    :parser: myst
+    :summary:
+    ```
+````
+
+### API
+
+````{py:function} uuid7_bounds_from_date(dt: datetime.date, tz=UTC) -> typing_extensions.Tuple[uuid.UUID, uuid.UUID]
+:canonical: lastuuid.utils.uuid7_bounds_from_date
+
+```{autodoc2-docstring} lastuuid.utils.uuid7_bounds_from_date
+:parser: myst
+```
+````
+
+````{py:function} uuid7_bounds_from_datetime(dt_lower: datetime.datetime, dt_upper: datetime.datetime | None = None) -> typing_extensions.Tuple[uuid.UUID, uuid.UUID]
+:canonical: lastuuid.utils.uuid7_bounds_from_datetime
+
+```{autodoc2-docstring} lastuuid.utils.uuid7_bounds_from_datetime
+:parser: myst
+```
+````

lastuuid-0.2.1/docs/source/index.md

@@ -0,0 +1,25 @@
+```{include} ../../README.md
+
+```
+
+```{toctree}
+:maxdepth: 1
+:caption: API:
+
+develop/lastuuid/lastuuid
+develop/lastuuid/lastuuid.dummies
+develop/lastuuid/lastuuid.utils
+```
+
+```{toctree}
+:maxdepth: 1
+:caption: Changelog:
+
+changelog
+```
+
+## Indices and tables
+
+- {ref}`genindex`
+- {ref}`modindex`
+- {ref}`search`

lastuuid-0.2.1/lastuuid/__init__.py

@@ -0,0 +1,9 @@
+"""
+lastuuid API.
+"""
+from .lastuuid import uuid7, uuid7_to_datetime
+
+__all__ = [
+    "uuid7",
+    "uuid7_to_datetime",
+]