Publish types, classes, and functions. (#197)

Author: tobiasraabe

.pre-commit-config.yaml

@@ -80,7 +80,8 @@ repos:
     rev: 1.5.0
     hooks:
     -   id: interrogate
-        args: [-v, --fail-under=40, src, tests]
+        args: [-v, --fail-under=75]
+        exclude: ^(tests/|docs/)
 -   repo: https://github.com/codespell-project/codespell
     rev: v2.1.0
     hooks:
@@ -90,6 +91,8 @@ repos:
     rev: "0.47"
     hooks:
     -   id: check-manifest
+        args: [--no-build-isolation]
+        additional_dependencies: [setuptools-scm, toml]
 -   repo: https://github.com/guilatrova/tryceratops
     rev: v1.0.1
     hooks:
@@ -108,7 +111,6 @@ repos:
             types-setuptools
         ]
         pass_filenames: false
-        language_version: "3.9"
 -   repo: meta
     hooks:
     -   id: check-hooks-apply

MANIFEST.in

@@ -1,6 +1,8 @@
 include CITATION
 include LICENSE
 
+recursive-include src py.typed
+
 exclude .coveragerc
 exclude *.yaml
 exclude *.yml

docs/rtd_environment.yml

@@ -27,6 +27,7 @@ dependencies:
   - pony >=0.7.15
   - pexpect
   - rich
+  - typing-extensions
 
   - pip:
     - ../

docs/source/changes.rst

@@ -10,6 +10,7 @@ all releases are available on `PyPI <https://pypi.org/project/pytask>`_ and
 0.1.9 - 2022-xx-xx
 ------------------
 
+- :gh:`197` publishes types, and adds classes and functions to the main namespace.
 - :gh:`217` enhances the tutorial on how to set up a project.
 - :gh:`218` removes ``depends_on`` and ``produces`` from the task function when parsed.
 - :gh:`219` removes some leftovers from pytest in :class:`~_pytask.mark.Mark`.

environment.yml

@@ -23,6 +23,7 @@ dependencies:
   - pluggy
   - pony >=0.7.15
   - rich
+  - typing-extensions
 
   # Misc
   - black

pyproject.toml

@@ -1,5 +1,6 @@
 [build-system]
 requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.0"]
+build-backend = "setuptools.build_meta"
 
 
 [tool.setuptools_scm]

setup.cfg

@@ -42,6 +42,7 @@ install_requires =
     pluggy
     pony>=0.7.15
     rich
+    typing-extensions
 python_requires = >=3.7
 include_package_data = True
 package_dir =

setup.py

@@ -1,3 +1,4 @@
+"""This module contains code related to click."""
 from __future__ import annotations
 
 from typing import Any
@@ -18,11 +19,16 @@
 
 
 class OptionHighlighter(RegexHighlighter):
+    """A highlighter for help texts."""
+
     highlights = [_SWITCH_REGEX, _OPTION_REGEX, _METAVAR_REGEX]
 
 
 class ColoredGroup(DefaultGroup):
+    """A subclass which colors groups with default commands."""
+
     def format_help(self: DefaultGroup, ctx: Any, formatter: Any) -> None:  # noqa: U100
+        """Format the help text."""
         highlighter = OptionHighlighter()
 
         console.print(
@@ -71,6 +77,7 @@ class ColoredCommand(click.Command):
     def format_help(
         self: click.Command, ctx: Any, formatter: Any  # noqa: U100
     ) -> None:
+        """Format the help text."""
         console.print(
             f"[b]pytask[/b] [dim]v{version}[/]\n", justify="center", highlight=False
         )
@@ -91,6 +98,7 @@ def format_help(
 
 
 def print_options(group_or_command: click.Command | DefaultGroup, ctx: Any) -> None:
+    """Print options formatted with a table in a panel."""
     highlighter = OptionHighlighter()
 
     options_table = Table(highlight=True, box=None, show_header=False)

src/_pytask/click.py

@@ -10,6 +10,9 @@
 from packaging.version import parse as parse_version
 
 
+__all__ = ["check_for_optional_program", "import_optional_dependency"]
+
+
 _MINIMUM_VERSIONS: dict[str, str] = {}
 """Dict[str, str]: A mapping from packages to their minimum versions."""