tinydantic 0.1.0__tar.gz → 0.1.2__tar.gz

{tinydantic-0.1.0 → tinydantic-0.1.2}/.github/workflows/publish.yml

@@ -56,6 +56,8 @@ jobs:
     if: github.repository_owner == 'cdwilson'
     needs:
       - publish-to-pypi
+    permissions:
+      contents: write
     runs-on: ubuntu-latest
     steps:
       - name: Download package dists

{tinydantic-0.1.0 → tinydantic-0.1.2}/.github/workflows/test.yml

@@ -42,6 +42,9 @@ jobs:
       - name: Install Hatch
         run: pip install --upgrade hatch
 
+      - name: Run pre-commit checks
+        run: hatch run pre-commit:check
+
       - name: Run static analysis
         run: hatch fmt --check
 

{tinydantic-0.1.0 → tinydantic-0.1.2}/.pre-commit-config.yaml

@@ -2,28 +2,41 @@
 #
 # SPDX-License-Identifier: Apache-2.0 OR MIT
 
+default_install_hook_types:
+  - pre-commit
+  - commit-msg
+
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.6.0
     hooks:
-      - id: trailing-whitespace
-        args: [--markdown-linebreak-ext=md]
+      - id: check-ast
+      - id: check-docstring-first
       - id: check-executables-have-shebangs
+      - id: check-json
       - id: check-merge-conflict
       - id: check-shebang-scripts-are-executable
       - id: check-symlinks
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+        args: [--allow-multiple-documents]
       - id: debug-statements
       - id: destroyed-symlinks
       - id: detect-aws-credentials
         args: [--allow-missing-credentials]
       - id: detect-private-key
       - id: end-of-file-fixer
+      - id: name-tests-test
+        args: [--pytest-test-first]
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
   - repo: https://github.com/fsfe/reuse-tool
     rev: v4.0.3
     hooks:
       - id: reuse
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.2
+    rev: v0.5.4
     hooks:
       - id: ruff
         args: [--fix]
@@ -31,6 +44,15 @@ repos:
   # Experimental taplo support
   # https://github.com/ComPWA/mirrors-taplo/issues/13#issuecomment-1930749688
   - repo: https://github.com/redeboer/taplo-pre-commit
-    rev: v0.9.1rc1
+    rev: 0.9.1rc1
     hooks:
       - id: taplo
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v3.28.0
+    hooks:
+      - id: commitizen
+  - repo: https://github.com/econchick/interrogate
+    rev: 1.7.0
+    hooks:
+      - id: interrogate
+        pass_filenames: false

tinydantic-0.1.2/.readthedocs.yaml

@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: Chris Wilson <christopher.david.wilson@gmail.com>
+#
+# SPDX-License-Identifier: Apache-2.0 OR MIT
+
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc
+
+mkdocs:
+  configuration: mkdocs.yml
+  fail_on_warning: true

{tinydantic-0.1.0 → tinydantic-0.1.2}/.vscode/extensions.json

@@ -7,6 +7,8 @@
     "ms-python.vscode-pylance",
     "ms-python.debugpy",
     "trond-snekvik.simple-rst",
-    "redhat.vscode-yaml"
+    "redhat.vscode-yaml",
+    "kennethlove.interrogate",
+    "vivaxy.vscode-conventional-commits"
   ]
 }

{tinydantic-0.1.0 → tinydantic-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: tinydantic
-Version: 0.1.0
+Version: 0.1.2
 Project-URL: Documentation, https://github.com/cdwilson/tinydantic#readme
 Project-URL: Issues, https://github.com/cdwilson/tinydantic/issues
 Project-URL: Source, https://github.com/cdwilson/tinydantic
@@ -19,6 +19,29 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.8
+Provides-Extra: compliance
+Requires-Dist: reuse>=4.0.0; extra == 'compliance'
+Provides-Extra: dev
+Requires-Dist: commitizen; extra == 'dev'
+Requires-Dist: interrogate; extra == 'dev'
+Requires-Dist: mkdocs-material; extra == 'dev'
+Requires-Dist: mkdocstrings; extra == 'dev'
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: packaging; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: reuse>=4.0.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: uv; extra == 'dev'
+Provides-Extra: doc
+Requires-Dist: mkdocs-material; extra == 'doc'
+Requires-Dist: mkdocstrings; extra == 'doc'
+Provides-Extra: pre-commit
+Requires-Dist: pre-commit; extra == 'pre-commit'
+Provides-Extra: test
+Requires-Dist: packaging; extra == 'test'
+Provides-Extra: types
+Requires-Dist: mypy>=1.0.0; extra == 'types'
+Requires-Dist: packaging; extra == 'types'
 Description-Content-Type: text/markdown
 
 # tinydantic

{tinydantic-0.1.0 → tinydantic-0.1.2}/REUSE.toml

@@ -20,6 +20,6 @@ precedence = "aggregate"
 SPDX-FileCopyrightText = "Chris Wilson <christopher.david.wilson@gmail.com>"
 SPDX-License-Identifier = "CC-BY-4.0"
 path = [
-  "*.md",
+  "**.md",
 ]
 precedence = "aggregate"

tinydantic-0.1.2/docs/index.md

@@ -0,0 +1 @@
+# Get Started

tinydantic-0.1.2/mkdocs.yml

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: Chris Wilson <christopher.david.wilson@gmail.com>
+#
+# SPDX-License-Identifier: Apache-2.0 OR MIT
+
+site_name: tinydantic
+site_url: https://cdwilson.github.io/tinydantic
+theme:
+  name: material
+plugins:
+  - search
+  - mkdocstrings

{tinydantic-0.1.0 → tinydantic-0.1.2}/pyproject.toml

@@ -42,6 +42,42 @@ name = "tinydantic"
 readme = "README.md"
 requires-python = ">=3.8"
 
+[project.optional-dependencies]
+compliance = [
+  "reuse>=4.0.0",
+]
+dev = [
+  "commitizen",
+  "interrogate",
+  "ruff",
+  "tinydantic[compliance,doc,pre-commit,test,types]",
+  "uv",
+]
+# "doc" is the reserved feature name to mark dependencies needed for generating
+# documentation:
+# https://packaging.python.org/en/latest/specifications/core-metadata/#provides-extra-multiple-use
+#
+# TODO(cdwilson): should this be changed to "docs"? "docs" appears to be more
+# popular than "doc":
+# https://github.com/scientific-python/specs/pull/324#issuecomment-2150738534
+doc = [
+  "mkdocs-material",
+  "mkdocstrings",
+]
+pre-commit = [
+  "pre-commit",
+]
+# "test" is the reserved feature name to mark dependencies needed for running
+# automated tests:
+# https://packaging.python.org/en/latest/specifications/core-metadata/#provides-extra-multiple-use
+test = [
+  "packaging",
+]
+types = [
+  "mypy>=1.0.0",
+  "packaging",   # TODO(cdwilson): this is duplicated in test
+]
+
 [project.urls]
 Documentation = "https://github.com/cdwilson/tinydantic#readme"
 Issues = "https://github.com/cdwilson/tinydantic/issues"
@@ -51,27 +87,50 @@ Source = "https://github.com/cdwilson/tinydantic"
 raw-options = { local_scheme = "no-local-version" }
 source = "vcs"
 
+[tool.hatch.envs.compliance]
+features = [
+  "compliance",
+]
+
+[tool.hatch.envs.compliance.scripts]
+check = "reuse lint"
+sbom = "reuse spdx -o reuse.spdx"
+
 [tool.hatch.envs.default]
-dependencies = [
-  "packaging",
-  "pytest",
-  "reuse",
-  'typing-extensions; python_version < "3.11"',
+features = [
+  "dev",
+]
+
+[tool.hatch.envs.doc]
+features = [
+  "doc",
+]
+
+# TODO(cdwilson): remove this when https://github.com/pypa/hatch/issues/1553
+# is implemented
+[tool.hatch.envs.hatch-test]
+features = [
+  "test",
 ]
 
 [tool.hatch.envs.types]
-extra-dependencies = [
-  "mypy>=1.0.0",
+features = [
+  "types",
 ]
 
 [tool.hatch.envs.types.scripts]
 check = "mypy --install-types --non-interactive {args:src/tinydantic tests}"
 
+[tool.hatch.envs.pre-commit]
+features = [
+  "pre-commit",
+]
+
+[tool.hatch.envs.pre-commit.scripts]
+check = "pre-commit run --all-files"
+
 [tool.coverage.run]
 branch = true
-omit = [
-  "src/tinydantic/__about__.py",
-]
 parallel = true
 source_pkgs = [
   "tests",
@@ -135,10 +194,6 @@ ignore = [
   "Q002",   # https://docs.astral.sh/ruff/rules/bad-quotes-docstring/
   "Q003",   # https://docs.astral.sh/ruff/rules/avoidable-escaped-quote/
   "W191",   # https://docs.astral.sh/ruff/rules/tab-indentation/
-
-  # TODO @cdwilson: these are temporary, remove them before release
-  "D",
-  "ERA001",
 ]
 select = [
   "ALL",
@@ -189,3 +244,21 @@ ban-relative-imports = "all" # https://docs.astral.sh/ruff/settings/#lint_flake8
 [tool.ruff.lint.flake8-pytest-style]
 fixture-parentheses = false
 mark-parentheses = false
+
+[tool.commitizen]
+major_version_zero = true
+name = "cz_conventional_commits"
+tag_format = "v$version"
+version_provider = "scm"
+version_scheme = "semver2"
+
+[tool.interrogate]
+exclude = [
+  ".hatch",
+]
+fail-under = 100
+ignore-private = true
+ignore-semiprivate = true
+omit-covered-files = true
+style = "google"
+verbose = 2

{tinydantic-0.1.0 → tinydantic-0.1.2}/tests/__init__.py

@@ -1,3 +1,5 @@
 # SPDX-FileCopyrightText: Chris Wilson <christopher.david.wilson@gmail.com>
 #
 # SPDX-License-Identifier: Apache-2.0 OR MIT
+
+"""Tests for the ``tinydantic`` package."""

tinydantic-0.1.2/tests/test_version.py

@@ -0,0 +1,30 @@
+# SPDX-FileCopyrightText: Chris Wilson <christopher.david.wilson@gmail.com>
+#
+# SPDX-License-Identifier: Apache-2.0 OR MIT
+
+"""Version tests."""
+
+from importlib import metadata
+
+from packaging.version import parse
+
+from tinydantic import __version__
+
+
+class TestPackageVersion:
+    """Package version tests."""
+
+    def test_version_is_a_string(self):
+        """Package version is a string."""
+        assert isinstance(__version__, str)
+
+    def test_version_matches_metadata_version(self):
+        """Package version matches installed metadata."""
+        assert __version__ == metadata.version("tinydantic")
+
+    def test_version_is_valid(self):
+        """Package version is compliant with PyPA Version specifiers.
+
+        See https://packaging.python.org/en/latest/specifications/version-specifiers/#version-specifiers
+        """
+        parse(__version__)

tinydantic-0.1.0/tests/test_version.py

@@ -1,20 +0,0 @@
-# SPDX-FileCopyrightText: Chris Wilson <christopher.david.wilson@gmail.com>
-#
-# SPDX-License-Identifier: Apache-2.0 OR MIT
-
-from importlib.metadata import version
-
-from packaging.version import parse
-
-from tinydantic import __version__
-
-
-class TestVersion:
-    def test_version_is_a_string(self):
-        assert isinstance(__version__, str)
-
-    def test_version_matches_metadata_version(self):
-        assert __version__ == version("tinydantic")
-
-    def test_version_is_valid(self):
-        parse(__version__)