Switch from setuptools to hatch

Author: pcisar

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 FirebirdSQL
+Copyright (c) 2019-present The Firebird Project <www.firebirdsql.org>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -24,15 +24,32 @@ The UUID RFC pre-defines four namespaces:
 
 ## ISO OID
 
-An OID is a globally unique [ISO](http://www.iso.org/iso/en/ISOOnline.frontpage) identifier. There are multiple ways that this identifier may be represented, and Firebird Foundation has chosen to represent OID registered here using a form that consists only of numbers and dots (e.g., "1.3.6.1.4.1.53446.1"). OIDs are paths in a tree structure, with the left-most number representing the root and the right-most number representing a leaf.
-
-Each OID is created by a Registration Authority. Each of these authorities may, in turn, delegate assignment of new OIDs under it to other registration authorities that work under its auspices, and so on down the line. Eventually, one of these authorities assigns a unique (to it) number that corresponds to a leaf node on the tree. The leaf may represent a registration authority (in which case the OID identifies the authority), or an instance of an object. A registration authority owns the namespace consisting of its sub-tree.
-
-The [Firebird Foundation Incorporated](https://firebirdsql.org/en/firebird-foundation) obtained a [PEN](https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers) (Private Enterprise Number) from [IANA](https://www.iana.org), and thus become a registered owner of OID _1.3.6.1.4.1.53446_ (iso.org.dod.internet.private.enterprise.firebird-foundation-inc). This repository is used to manage sub-tree of OIDs under this namespace, that are used by Firebird Foundation and the [Firebird Project](https://www.firebirdsql.org).
+An OID is a globally unique [ISO](http://www.iso.org/iso/en/ISOOnline.frontpage) identifier. 
+There are multiple ways that this identifier may be represented, and Firebird Foundation has 
+chosen to represent OID registered here using a form that consists only of numbers and dots 
+(e.g., "1.3.6.1.4.1.53446.1"). OIDs are paths in a tree structure, with the left-most number 
+representing the root and the right-most number representing a leaf.
+
+Each OID is created by a Registration Authority. Each of these authorities may, in turn, 
+delegate assignment of new OIDs under it to other registration authorities that work under its 
+auspices, and so on down the line. Eventually, one of these authorities assigns a unique (to it) 
+number that corresponds to a leaf node on the tree. The leaf may represent a registration authority 
+(in which case the OID identifies the authority), or an instance of an object. A registration 
+authority owns the namespace consisting of its sub-tree.
+
+The [Firebird Foundation Incorporated](https://firebirdsql.org/en/firebird-foundation) obtained 
+a [PEN](https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers) (Private Enterprise 
+Number) from [IANA](https://www.iana.org), and thus become a registered owner of OID _1.3.6.1.4.1.53446_ 
+(iso.org.dod.internet.private.enterprise.firebird-foundation-inc). This repository is used to manage 
+sub-tree of OIDs under this namespace, that are used by Firebird Foundation and 
+the [Firebird Project](https://www.firebirdsql.org).
 
 # How it works
 
-The OID hierarchy is controlled by a set of YAML files, each file describing one level in the tree hierarchy (that is, the root node of the child tree and all assigned nodes for children). The `root.oid` file describes the OID of highest level (assigned by IANA).
+The OID hierarchy is controlled by a set of YAML files, each file describing one level 
+in the tree hierarchy (that is, the root node of the child tree and all assigned nodes 
+for children). The [root.oid](https://github.com/FirebirdSQL/firebird-uuid/blob/master/root.oid) file 
+in this repository describes the OID of highest level (assigned by IANA).
 
 Each file has the following format:
 
@@ -62,7 +79,10 @@ children:
 
 **All fields must be present, and if not specified otherwise, they must have a value.**
 
-Fields `name`,`description`,`contact`,`email` and `site` in `children` record SHOULD have the same values like fields of the same name in `node` record of the YAML file describing the child node. If they differ in content, the values present in `node` record take precedence over values present in `children` record.
+Fields `name`,`description`,`contact`,`email` and `site` in `children` record SHOULD have 
+the same values like fields of the same name in `node` record of the YAML file describing 
+the child node. If they differ in content, the values present in `node` record take precedence 
+over values present in `children` record.
 
 # Using OIDs to generate UUIDs
 
@@ -82,3 +102,7 @@ python:
 UUID('6f8c9fea-acfa-5b49-af8a-11aca8d0c4a0')
 ```
 
+# Python package for work with Firebird OID namespace
+
+The Firebird Project provides [firebird-uuid](https://pypi.org/project/firebird-uuid/) Python package
+for work with OID hierarchy definitions in format defined above.

python/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Change Log
+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/).
+
+## [Unreleased] - yyyy-mm-dd
+
+### Changed
+
+- Update dependency to firebird-base >=1.6.1
+- Build system changed from setuptools to hatch
+- Package version is now defined in firebird.uuid.__about__.py (__version__)
+
+### Added
+
+- Stub pytest test
+
+## [0.2.0] - 2023-03-02
+
+### Changed
+
+- Refactoring
+
+### Added
+
+- Documentation.
+
+## [0.1.0] - 2022-11-28
+
+Initial release.
+

python/LICENSE

@@ -1,21 +1,20 @@
 MIT License
 
-Copyright (c) 2018-2020 Firebird Project (www.firebirdsql.org)
+Copyright (c) 2022-present The Firebird Project <www.firebirdsql.org>
 
-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:
+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
+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.
+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.

python/README.md

@@ -0,0 +1,29 @@
+# firebird-uuid
+
+[![PyPI - Version](https://img.shields.io/pypi/v/firebird-uuid.svg)](https://pypi.org/project/firebird-uuid)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/firebird-uuid.svg)](https://pypi.org/project/firebird-uuid)
+[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
+
+This package provides official tools for working with the OID namespace managed by the Firebird Project.
+
+-----
+
+**Table of Contents**
+
+- [Installation](#installation)
+- [License](#license)
+- [Documentation](#documentation)
+
+## Installation
+
+```console
+pip install firebird-uuid
+```
+
+## License
+
+`firebird-uuid` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+
+## Documentation
+
+The documentation for this package is available at [https://firebird-uuid.readthedocs.io](https://firebird-uuid.readthedocs.io)

python/README.rst

@@ -2,6 +2,13 @@
 Changelog
 #########
 
+Version 0.3.0
+=============
+
+* Switch from setuptools to `hatch <https://hatch.pypa.io/latest/>`_.
+* Update dependency to firebird-base >=1.6.1
+* Package version is now defined in firebird.uuid.__about__.py (__version__)
+
 Version 0.2.0
 =============
 

python/docs/changelog.txt

@@ -4,6 +4,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 import sphinx_bootstrap_theme
+from firebird.uuid.__about__ import __version__
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
@@ -13,10 +14,10 @@
 author = 'Pavel Císař'
 
 # The short X.Y version
-version = '0.2.0'
+version = __version__
 
 # The full version, including alpha/beta/rc tags
-release = '0.2.0'
+release = __version__
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

python/docs/conf.py

@@ -2,9 +2,8 @@
 Firebird UUID Management
 ########################
 
-The `firebird-uuid` package provides official tools to work with OID namespace maintained
-by `Firebird Project`_.
-
+The `firebird-uuid` package provides the official tools for working with the OID namespace 
+managed by the `Firebird project`_.
 
 Content
 *******

python/docs/index.txt

@@ -1,4 +1,4 @@
 sphinx-bootstrap-theme>=0.8.1
-sphinx-autodoc-typehints>=1.19.4
-sphinx>=5.3
+sphinx-autodoc-typehints>=1.24.0
+sphinx>=7.1
 ./python