Release 1.0.0

Author: pcisar

python/CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.0.0] - 2025-05-28
+
+### Changed
+
+- Promoted to stable
+- Improved documentation
+
 ## [0.4.0] - 2025-04-29
 
 ### Added
@@ -16,7 +23,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Code cleanup and optimization for Python 3.11 features.
 - Improved documentation.
 - Changed dependency from `toml` to `tomli-w`.
-- Breaking changes: `Node` renamed to `OIDNode`, `NodeTYpe` renamed to `OIDNodeType`
+- Breaking changes: `Node` renamed to `OIDNode`, `NodeType` renamed to `OIDNodeType`
 
 ## [0.3.0] - 2023-10-03
 

python/docs/changelog.txt

@@ -2,6 +2,13 @@
 Changelog
 #########
 
+Version 1.0.0
+=============
+Released: 2025-05-28
+
+* Promoted to stable
+* Improved documentation
+
 Version 0.4.0
 =============
 Released: 2025-04-29
@@ -11,7 +18,7 @@ Released: 2025-04-29
 * Code cleanup and optimization for Python 3.11 features.
 * Improved documentation.
 * Changed dependency from `toml` to `tomli-w`.
-* Breaking changes: `Node` renamed to `.OIDNode`, `NodeTYpe` renamed to `.OIDNodeType`
+* Breaking changes: `Node` renamed to `.OIDNode`, `NodeType` renamed to `.OIDNodeType`
 
 Version 0.3.0
 =============

python/docs/conf.py

@@ -10,7 +10,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'firebird-uuid'
-copyright = '2022, The Firebird Project'
+copyright = '2022-present, The Firebird Project'
 author = 'Pavel Císař'
 
 # The short X.Y version
@@ -70,6 +70,7 @@
     # an arbitrary url.
     'navbar_links': [
         #("Usage Guide", "usage-guide"),
+        ("Introduction", "introduction"),
         ("Reference", "reference"),
         ("Index", "genindex"),
     ],

python/docs/index.txt

@@ -2,8 +2,8 @@
 Firebird UUID Management
 ########################
 
-The `firebird-uuid` package provides the official tools for working with the OID namespace 
-managed by the `Firebird project`_.
+The `firebird-uuid` package provides the official tools for working with the OID namespace
+managed by the `Firebird project`_ at `GitHub <https://github.com/FirebirdSQL/firebird-uuid>`_.
 
 Content
 *******
@@ -12,6 +12,7 @@ Content
    :maxdepth: 2
    :caption: Contents:
 
+   introduction
    reference
    changelog
 

python/docs/reference.txt

@@ -5,7 +5,13 @@ Firebird-uuid Reference
 #######################
 
 .. autodata:: ROOT_SPEC
+
+   **URL for ROOT specification**
+
 .. autodata:: IANA_ROOT_NAME
+
+   **IANA name before Firebird namespace. Does not contain trailing dot.**
+
 .. autodata:: oid_registry
 
 .. autofunction:: get_specification

python/pyproject.toml

@@ -14,7 +14,7 @@ authors = [
   { name = "Pavel Cisar", email = "[email protected]" },
 ]
 classifiers = [
-  "Development Status :: 4 - Beta",
+  "Development Status :: 5 - Production/Stable",
   "Programming Language :: Python :: 3 :: Only",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
@@ -59,24 +59,6 @@ allow-direct-references = true
 dependencies = [
 ]
 
-[tool.hatch.envs.test]
-dependencies = [
-  "coverage[toml]>=6.5",
-  "pytest",
-]
-[tool.hatch.envs.test.scripts]
-test = "pytest {args:tests}"
-test-cov = "coverage run -m pytest {args:tests}"
-cov-report = [
-  "- coverage combine",
-  "coverage report",
-]
-cov = [
-  "test-cov",
-  "cov-report",
-]
-version = "python --version"
-
 [[tool.hatch.envs.hatch-test.matrix]]
 python = ["3.11", "3.12", "3.13"]
 

python/src/firebird/uuid/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2022-present The Firebird Projects <www.firebirdsql.org>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.4.0"
+__version__ = "1.0.0"

python/src/firebird/uuid/_model.py

@@ -61,20 +61,18 @@
 
 class OIDNodeType(Enum):
     """Enumeration of possible types for an `OIDNode`.
-
-    Attributes:
-        ROOT: The top-level node in a specific OID specification file.
-              Only one true root (from IANA) exists in the full conceptual tree.
-        LEAF: A terminal node in the hierarchy; it cannot have children defined
-              in a separate specification file.
-        PRIVATE: A node reserved for private use, similar to a LEAF in that it
-                 does not link to a separate specification file for children.
-        NODE: An intermediate node that references another specification file
-              (via `node_spec`) to define its children.
     """
+    #: The top-level node in a specific OID specification file.
+    #: Only one true root (from IANA) exists in the full conceptual tree.
     ROOT = 'root'
+    #: A terminal node in the hierarchy; it cannot have children defined
+    #: in a separate specification file.
     LEAF = 'leaf'
+    #: A node reserved for private use, similar to a LEAF in that it
+    #: does not link to a separate specification file for children.
     PRIVATE = 'private'
+    #: An intermediate node that references another specification file
+    #: (via `node_spec`) to define its children.
     NODE = 'node'
 
 class OIDNode(Distinct):

python/src/firebird/uuid/_registry.py

@@ -99,7 +99,7 @@ def update_from_specifications(self, specifications: dict[str, dict[str, Any]])
             self.update(node.children)
         self.update(nodes)
         build_tree(self._reg.values())
-    def update_from_toml(self, toml: str) -> None:
+    def update_from_toml(self, toml_data: str) -> None:
         """Updates the registry by loading node data from a TOML document string.
 
         Parses the TOML string, which is expected to contain a dictionary mapping
@@ -108,7 +108,7 @@ def update_from_toml(self, toml: str) -> None:
 
         Performs validation checks before loading:
 
-        - Ensures the TOML data either defines a root node (`node_type`='root'
+        - Ensures the TOML data either defines a root node (node_type='root'
           and no 'parent') or contains at least one node whose parent UUID
           already exists in the current registry.
         - If a root node is defined in the TOML and a root node is already
@@ -136,7 +136,7 @@ def update_from_toml(self, toml: str) -> None:
             KeyError: If essential keys like 'node_type' are missing in the TOML data
                       for a node.
         """
-        data: dict[str, Any] = loads(toml)
+        data: dict[str, Any] = loads(toml_data)
         # Validate data
         known: set[uuid.UUID] = set(self.keys())
         has_root_node: bool = False