Merge pull request #3 from idiap/types

Add full typing support

.github/workflows/main.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v3
         with:
-          version: "0.4.21"
+          version: "0.4.27"
           enable-cache: true
           cache-dependency-glob: "**/pyproject.toml"
       - name: Set up Python ${{ matrix.python-version }}

.github/workflows/pypi-release.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v3
         with:
-          version: "0.4.21"
+          version: "0.4.27"
           enable-cache: true
           cache-dependency-glob: "**/pyproject.toml"
       - name: Set up Python
@@ -43,7 +43,7 @@ jobs:
     needs: [build]
     environment:
       name: release
-      url: https://pypi.org/p/coqui-tts-coqpit
+      url: https://pypi.org/p/coqpit-config
     permissions:
       id-token: write
     steps:

.gitignore

@@ -1,3 +1,5 @@
+uv.lock
+
 WadaSNR/
 .idea/
 *.pyc

.pre-commit-config.yaml

@@ -12,3 +12,10 @@ repos:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.12.0
+    hooks:
+      - id: mypy
+        args: [--strict]
+        additional_dependencies:
+          - "pytest"

README.md

@@ -2,9 +2,12 @@
 
 [![CI](https://github.com/idiap/coqui-ai-coqpit/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/idiap/coqui-ai-coqpit/actions/workflows/main.yml)
 
-Simple, light-weight and no dependency config handling through python data classes with to/from JSON serialization/deserialization.
+Simple, light-weight and no dependency config handling through python data
+classes with to/from JSON serialization/deserialization.
 
-Currently it is being used by [🐸TTS](https://github.com/idiap/coqui-ai-TTS).
+Fork of the [original, unmaintained repository](https://github.com/coqui-ai/coqpit). New PyPI package: [coqpit-config](https://pypi.org/project/coqpit-config)
+
+Currently it is being used by [coqui-tts](https://github.com/idiap/coqui-ai-TTS).
 
 ## ❔ Why I need this
 What I need from a ML configuration library...

coqpit/__init__.py

@@ -1,8 +1,7 @@
 import importlib.metadata
-from dataclasses import dataclass
 
 from coqpit.coqpit import MISSING, Coqpit, check_argument
 
-__all__ = ["dataclass", "MISSING", "Coqpit", "check_argument"]
+__all__ = ["MISSING", "Coqpit", "check_argument"]
 
 __version__ = importlib.metadata.version("coqpit")