Prepare release v1.0.0

.gitignore

@@ -9,6 +9,7 @@ __pycache__/
 pip-wheel-metadata
 
 # Virtualenv
+.venv/
 /env/
 /src/
 
@@ -21,3 +22,7 @@ htmlcov
 
 # Sphinx documentation
 /doc/build/
+/doc/_build/
+
+# Type checkers
+.mypy_cache/

.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
     rev: "7.3.0"
     hooks:
       - id: flake8
-        additional_dependencies: [flake8-pyproject]
+        additional_dependencies: [flake8-pyproject, flake8-type-checking]
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.21.2
     hooks:

CHANGES.txt

@@ -1,26 +1,28 @@
 CHANGES
 *******
 
-0.15 (unreleased)
-=================
+1.0.0 (unreleased)
+==================
 
 - Add type hints
 
 - Add partial attribute to directive methods for better typing support
 
-- Fix Flake8 errors.
-
-- Apply Black code formatter.
+- Fix linting errors.
 
 - Add support for Python 3.10, 3.11, 3.12, 3.13 and 3.14
 
 - Drop support for Python 3.9 and below
 
 - Use GitHub Actions instead of Travis for CI.
-(Travis no longer gives free credits to open source projects.)
+  (Travis no longer gives free credits to open source projects.)
 
 - Cleanup old Python 2 code with pyupgrade_.
 
+- Add tests for 100% coverage.
+
+- Update docs.
+
   .. _pyupgrade: https://github.com/asottile/pyupgrade
 
 

CREDITS.txt

@@ -8,7 +8,7 @@ CREDITS
 
 * Denis Krienbühl (testing and feedback)
 
-* Henri Hulski (build environment)
+* Henri Hulski (build environment and maintainer)
 
 * Jan Stürtz
 

README.rst

@@ -19,8 +19,8 @@ Dectate is a powerful configuration engine for Python frameworks.
 
 `Read the docs`_
 
-.. _`Read the docs`: http://dectate.readthedocs.org
+.. _`Read the docs`: https://dectate.readthedocs.io
 
 It is used by Morepath_.
 
-.. _Morepath: http://morepath.readthedocs.org
+.. _Morepath: https://morepath.readthedocs.io

dectate/__init__.py

@@ -1,16 +1,16 @@
 from .app import App, directive
-from .sentinel import Sentinel, NOT_FOUND
-from .config import commit, Action, Composite, CodeInfo
+from .config import Action, CodeInfo, Composite, commit
 from .error import (
     ConfigError,
+    ConflictError,
     DirectiveError,
-    TopologicalSortError,
     DirectiveReportError,
-    ConflictError,
     QueryError,
+    TopologicalSortError,
 )
 from .query import Query
-from .tool import query_tool, convert_dotted_name, convert_bool, query_app
+from .sentinel import NOT_FOUND, Sentinel
+from .tool import convert_bool, convert_dotted_name, query_app, query_tool
 from .toposort import topological_sort
 
 __all__ = (

dectate/app.py

@@ -11,15 +11,16 @@
     TypeVar,
     cast,
 )
+
 from .config import Configurable, Directive, commit, create_code_info
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Collection, Iterator
     from typing_extensions import Self
+
     from .config import Action, Composite, DirectiveAbbreviation
     from .types import DirectiveCallable
 
-_T = TypeVar("_T")
 _ActionT = TypeVar("_ActionT", bound="Action | Composite")
 _AppT = TypeVar("_AppT", bound="App")
 _P = ParamSpec("_P")
@@ -173,7 +174,7 @@ class DirectiveMethod(Generic[_AppT, _P]):
     __name__: str
     __qualname__: str
 
-    def __init__(self, func: DirectiveCallable[Concatenate[Any, _P]]):
+    def __init__(self, func: DirectiveCallable[Concatenate[Any, _P]]) -> None:
         self.__func__ = func
         update_wrapper(self, func)  # type: ignore[arg-type]
 
@@ -197,8 +198,8 @@ def directive(
     :class:`dectate.Composite` subclass and can attach the result as a
     class method to an :class:`dectate.App` subclass::
 
-      class FooAction(dectate.Action):
-          ...
+      class FooAction(dectate.Action): ...
+
 
       class MyApp(dectate.App):
           my_directive = dectate.directive(MyAction)
@@ -208,16 +209,14 @@ class MyApp(dectate.App):
 
       class MyApp(dectate.App):
           @directive
-          class my_directive(dectate.Action):
-              ...
+          class my_directive(dectate.Action): ...
 
     :param action_factory: an action class to use as the directive.
     :return: a class method that represents the directive.
     """
     if not isinstance(action_factory, type):
-        raise TypeError(
-            "action_factory needs to be `dectate.Action` or `dectate.Composite` subclass."
-        )
+        msg = "action_factory needs to be `dectate.Action` or `dectate.Composite` subclass."
+        raise TypeError(msg)
 
     def method(cls: Any, *args: _P.args, **kw: _P.kwargs) -> Directive:
         frame = sys._getframe(2)