pyprojkit 0.5.0__tar.gz → 0.7.0__tar.gz

{pyprojkit-0.5.0 → pyprojkit-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyprojkit
-Version: 0.5.0
+Version: 0.7.0
 Summary: Development workflow toolkit for Python projects: pyproject.toml sync, doit tasks, nox sessions
 Author: mm21
 Author-email: mm21 <mm21.dev@gmail.com>
@@ -183,7 +183,7 @@ Tool configurations are grouped by category under `ToolsConfig`. Every category
 - `publish`: build/publish output directory
 - `skill`: a `pyprojkit-python` [agent skill](https://agentskills.io) generated from the configuration
 
-`create_kitchen_sink_tools()` returns a `ToolsConfig` with everything enabled (except sphinx, which needs project-specific settings). Customize it with `dataclasses.replace`:
+`create_recommended_tools()` returns a `ToolsConfig` with everything enabled (except sphinx, which needs project-specific settings). Customize it with `dataclasses.replace`:
 
 ```python
 from dataclasses import replace
@@ -195,7 +195,7 @@ from pyprojkit import (
     PythonVersions,
     RequiresPython,
     SphinxConfig,
-    create_kitchen_sink_tools,
+    create_recommended_tools,
 )
 
 config = ProjectConfig(
@@ -203,7 +203,7 @@ config = ProjectConfig(
     requires_python=RequiresPython((3, 12)),
     pinned_python=PythonVersions(3, (12, 14)),
     tools=replace(
-        create_kitchen_sink_tools(),
+        create_recommended_tools(),
         doc=DocConfig(sphinx=SphinxConfig(copy_env_var="MY_PACKAGE_DOCS_DIR")),
         analysis=None,
     ),
@@ -214,7 +214,7 @@ To tweak a managed value, replace it in the tool's config:
 
 ```python
 tools=replace(
-    create_kitchen_sink_tools(),
+    create_recommended_tools(),
     test=TestConfig(pytest=PytestConfig(addopts="-x")),
 )
 ```
@@ -334,11 +334,11 @@ There is no profile registry: a shared configuration is just a function or globa
 # in your shared module, e.g. mycompany_config.py
 from dataclasses import replace
 
-from pyprojkit import AnalysisConfig, ToolsConfig, create_kitchen_sink_tools
+from pyprojkit import AnalysisConfig, ToolsConfig, create_recommended_tools
 
 
 def create_mycompany_tools() -> ToolsConfig:
-    return replace(create_kitchen_sink_tools(), analysis=AnalysisConfig())
+    return replace(create_recommended_tools(), analysis=AnalysisConfig())
 ```
 
 ```python

{pyprojkit-0.5.0 → pyprojkit-0.7.0}/README.md

@@ -140,7 +140,7 @@ Tool configurations are grouped by category under `ToolsConfig`. Every category
 - `publish`: build/publish output directory
 - `skill`: a `pyprojkit-python` [agent skill](https://agentskills.io) generated from the configuration
 
-`create_kitchen_sink_tools()` returns a `ToolsConfig` with everything enabled (except sphinx, which needs project-specific settings). Customize it with `dataclasses.replace`:
+`create_recommended_tools()` returns a `ToolsConfig` with everything enabled (except sphinx, which needs project-specific settings). Customize it with `dataclasses.replace`:
 
 ```python
 from dataclasses import replace
@@ -152,7 +152,7 @@ from pyprojkit import (
     PythonVersions,
     RequiresPython,
     SphinxConfig,
-    create_kitchen_sink_tools,
+    create_recommended_tools,
 )
 
 config = ProjectConfig(
@@ -160,7 +160,7 @@ config = ProjectConfig(
     requires_python=RequiresPython((3, 12)),
     pinned_python=PythonVersions(3, (12, 14)),
     tools=replace(
-        create_kitchen_sink_tools(),
+        create_recommended_tools(),
         doc=DocConfig(sphinx=SphinxConfig(copy_env_var="MY_PACKAGE_DOCS_DIR")),
         analysis=None,
     ),
@@ -171,7 +171,7 @@ To tweak a managed value, replace it in the tool's config:
 
 ```python
 tools=replace(
-    create_kitchen_sink_tools(),
+    create_recommended_tools(),
     test=TestConfig(pytest=PytestConfig(addopts="-x")),
 )
 ```
@@ -291,11 +291,11 @@ There is no profile registry: a shared configuration is just a function or globa
 # in your shared module, e.g. mycompany_config.py
 from dataclasses import replace
 
-from pyprojkit import AnalysisConfig, ToolsConfig, create_kitchen_sink_tools
+from pyprojkit import AnalysisConfig, ToolsConfig, create_recommended_tools
 
 
 def create_mycompany_tools() -> ToolsConfig:
-    return replace(create_kitchen_sink_tools(), analysis=AnalysisConfig())
+    return replace(create_recommended_tools(), analysis=AnalysisConfig())
 ```
 
 ```python

{pyprojkit-0.5.0 → pyprojkit-0.7.0}/pyproject.toml

@@ -29,7 +29,7 @@ license-files = ["LICENSE"]
 name = "pyprojkit"
 readme = "README.md"
 requires-python = ">=3.12,<4.0"  # pyprojkit-managed
-version = "0.5.0"
+version = "0.7.0"
 
 [project.optional-dependencies]
 all = [
@@ -108,7 +108,6 @@ quiet = true  # pyprojkit-managed
 
 [tool.mypy]
 check_untyped_defs = true  # pyprojkit-managed
-ignore_missing_imports = true  # pyprojkit-managed
 python_version = "3.12"  # pyprojkit-managed
 
 [tool.nox]

{pyprojkit-0.5.0 → pyprojkit-0.7.0}/src/pyprojkit/__init__.py

@@ -44,7 +44,7 @@ from .config import (
     AnalysisConfig,
     PublishConfig,
     SkillConfig,
-    create_kitchen_sink_tools,
+    create_recommended_tools,
 )
 from .versions import (
     DEFAULT_PATCH_VERSIONS,
@@ -98,7 +98,7 @@ __all__ = [
     "AnalysisConfig",
     "PublishConfig",
     "SkillConfig",
-    "create_kitchen_sink_tools",
+    "create_recommended_tools",
     "DEFAULT_PATCH_VERSIONS",
     "PythonVersions",
     "PythonVersionSet",

{pyprojkit-0.5.0 → pyprojkit-0.7.0}/src/pyprojkit/config/__init__.py

@@ -44,7 +44,7 @@ from .project import (
     SkillConfig,
 )
 from .profiles import (
-    create_kitchen_sink_tools,
+    create_recommended_tools,
 )
 
 __all__ = [
@@ -74,6 +74,6 @@ __all__ = [
     "AnalysisConfig",
     "PublishConfig",
     "SkillConfig",
-    "create_kitchen_sink_tools",
+    "create_recommended_tools",
 ]
 # </AUTOGEN_INIT>

{pyprojkit-0.5.0 → pyprojkit-0.7.0}/src/pyprojkit/config/base.py

@@ -31,16 +31,15 @@ class BaseConfig(ABC):
     individual tools' `pyproject.toml` tables (e.g. `PytestConfig`).
 
     A default-constructed config is empty: every setting is unset and every optional
-    sub-config is disabled. Opinionated settings are provided by
-    `create_kitchen_sink()`.
+    sub-config is disabled. Opinionated settings are provided by `create_recommended()`.
     """
 
     @classmethod
     @abstractmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         """
         Get a new instance with opinionated settings, as used by
-        `create_kitchen_sink_tools()`.
+        `create_recommended_tools()`.
         """
         ...
 

{pyprojkit-0.5.0 → pyprojkit-0.7.0}/src/pyprojkit/config/profiles.py

@@ -30,7 +30,7 @@ def create_mycompany_tools() -> ToolsConfig:
     )
 ```
 
-Alternatively, start from `create_kitchen_sink_tools()` and override parts of it with
+Alternatively, start from `create_recommended_tools()` and override parts of it with
 `dataclasses.replace()`.
 """
 
@@ -39,13 +39,14 @@ from __future__ import annotations
 from .project import ToolsConfig
 
 __all__ = [
-    "create_kitchen_sink_tools",
+    "create_recommended_tools",
 ]
 
 
-def create_kitchen_sink_tools() -> ToolsConfig:
+def create_recommended_tools() -> ToolsConfig:
     """
-    Get a new instance of the configuration which enables every tool; equivalent to
-    `ToolsConfig.create_kitchen_sink()`.
+    Get a new instance of the recommended configuration: every tool which doesn't need
+    project-specific settings, with opinionated settings; equivalent to
+    `ToolsConfig.create_recommended()`.
     """
-    return ToolsConfig.create_kitchen_sink()
+    return ToolsConfig.create_recommended()

{pyprojkit-0.5.0 → pyprojkit-0.7.0}/src/pyprojkit/config/project.py

@@ -52,14 +52,14 @@ class FormattingConfig(BaseConfig):
     """
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(
             formatters=(
-                AutoflakeConfig.create_kitchen_sink(),
-                IsortConfig.create_kitchen_sink(),
-                DocfmtConfig.create_kitchen_sink(),
-                BlackConfig.create_kitchen_sink(),
-                TomlSortConfig.create_kitchen_sink(),
+                AutoflakeConfig.create_recommended(),
+                IsortConfig.create_recommended(),
+                DocfmtConfig.create_recommended(),
+                BlackConfig.create_recommended(),
+                TomlSortConfig.create_recommended(),
             )
         )
 
@@ -75,11 +75,11 @@ class TestConfig(BaseConfig):
     coverage_report: CoverageReportConfig = field(default_factory=CoverageReportConfig)
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(
-            pytest=PytestConfig.create_kitchen_sink(),
-            coverage_run=CoverageRunConfig.create_kitchen_sink(),
-            coverage_report=CoverageReportConfig.create_kitchen_sink(),
+            pytest=PytestConfig.create_recommended(),
+            coverage_run=CoverageRunConfig.create_recommended(),
+            coverage_report=CoverageReportConfig.create_recommended(),
         )
 
 
@@ -95,7 +95,7 @@ class MkinitConfig(BaseConfig):
     """
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(
             args=("--recursive", "--nomods", "--relative", "-i", "--source-order")
         )
@@ -119,7 +119,7 @@ class SphinxConfig(BaseConfig):
     """
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls()
 
 
@@ -140,12 +140,12 @@ class DocConfig(BaseConfig):
     """
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         """
         Enables mkinit; sphinx is left disabled since it needs project-specific
         settings.
         """
-        return cls(mkinit=MkinitConfig.create_kitchen_sink())
+        return cls(mkinit=MkinitConfig.create_recommended())
 
 
 @dataclass(kw_only=True)
@@ -158,10 +158,10 @@ class AnalysisConfig(BaseConfig):
     pyright: PyrightConfig | None = None
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(
-            mypy=MypyConfig.create_kitchen_sink(),
-            pyright=PyrightConfig.create_kitchen_sink(),
+            mypy=MypyConfig.create_recommended(),
+            pyright=PyrightConfig.create_recommended(),
         )
 
 
@@ -178,7 +178,7 @@ class PublishConfig(BaseConfig):
     """
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(out_dir=str(_paths.UV_PATH))
 
 
@@ -198,7 +198,7 @@ class SkillConfig(BaseConfig):
     """
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls()
 
 
@@ -208,8 +208,8 @@ class ToolsConfig(BaseConfig):
     Development tool configurations, grouped by broad tool category.
 
     Every category is opt-in: `None` (the default) means the tool is neither managed nor
-    given a task. For a pre-canned set of everything, see `create_kitchen_sink()` (also
-    available as `create_kitchen_sink_tools()`); to share a configuration across
+    given a task. For a pre-canned set of everything, see `create_recommended()` (also
+    available as `create_recommended_tools()`); to share a configuration across
     projects, define your own factory function or global.
     """
 
@@ -233,7 +233,7 @@ class ToolsConfig(BaseConfig):
     """
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         """
         Enables every tool category, each with its opinionated settings: uv as the
         workflow tool, formatting, testing, doit, nox, mkinit, static analysis,
@@ -242,14 +242,14 @@ class ToolsConfig(BaseConfig):
         """
         return cls(
             workflow_tool="uv",
-            formatting=FormattingConfig.create_kitchen_sink(),
-            test=TestConfig.create_kitchen_sink(),
-            doit=DoitConfig.create_kitchen_sink(),
-            nox=NoxConfig.create_kitchen_sink(),
-            doc=DocConfig.create_kitchen_sink(),
-            analysis=AnalysisConfig.create_kitchen_sink(),
-            publish=PublishConfig.create_kitchen_sink(),
-            skill=SkillConfig.create_kitchen_sink(),
+            formatting=FormattingConfig.create_recommended(),
+            test=TestConfig.create_recommended(),
+            doit=DoitConfig.create_recommended(),
+            nox=NoxConfig.create_recommended(),
+            doc=DocConfig.create_recommended(),
+            analysis=AnalysisConfig.create_recommended(),
+            publish=PublishConfig.create_recommended(),
+            skill=SkillConfig.create_recommended(),
         )
 
 

{pyprojkit-0.5.0 → pyprojkit-0.7.0}/src/pyprojkit/config/tools.py

@@ -3,7 +3,7 @@ Configurations for all supported tools.
 
 Formatters are tools which additionally run as part of the `format` task. Every field
 defaults to `None` (unset); each tool's opinionated settings are provided by its
-`create_kitchen_sink()`.
+`create_recommended()`.
 """
 
 from __future__ import annotations
@@ -50,7 +50,7 @@ class AutoflakeConfig(BaseFormatterConfig):
     )
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(
             in_place=True,
             recursive=True,
@@ -70,7 +70,7 @@ class IsortConfig(BaseFormatterConfig):
     quiet: bool | None = None
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(profile="black", quiet=True)
 
     def command(self, py_paths: list[str], toml_paths: list[str]) -> list[str]:
@@ -84,7 +84,7 @@ class BlackConfig(BaseFormatterConfig):
     quiet: bool | None = None
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(quiet=True)
 
     def extra_toml(self, project: ProjectConfig) -> dict[str, Any]:
@@ -114,7 +114,7 @@ class DocfmtConfig(BaseFormatterConfig):
     force_reflow: bool | None = field(default=None, metadata={"toml": "force-reflow"})
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(
             in_place=True, recursive=True, summary_on_own_line=True, force_reflow=True
         )
@@ -135,7 +135,7 @@ class TomlSortConfig(BaseFormatterConfig):
     spaces_before_inline_comment: int | None = None
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(
             sort_first=("project", "dependency-groups", "build-system"),
             sort_table_keys=True,
@@ -158,7 +158,7 @@ class PytestConfig(BaseToolConfig):
     testpaths: str | None = None
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(
             addopts="--import-mode=importlib -s -v -rA",
             cache_dir=str(_paths.PYTEST_CACHE_PATH),
@@ -173,7 +173,7 @@ class CoverageRunConfig(BaseToolConfig):
     data_file: str | None = None
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(data_file=str(_paths.COVERAGE_DATA_PATH))
 
 
@@ -184,7 +184,7 @@ class CoverageReportConfig(BaseToolConfig):
     exclude_lines: tuple[str, ...] | None = None
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(exclude_lines=("if TYPE_CHECKING:", "\\.\\.\\.$"))
 
 
@@ -196,7 +196,7 @@ class DoitConfig(BaseToolConfig):
     verbosity: int | None = None
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(dep_file=str(_paths.DOIT_DB_PATH), verbosity=2)
 
 
@@ -208,7 +208,7 @@ class NoxConfig(BaseToolConfig):
     envdir: str | None = None
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls(default_venv_backend="uv", envdir=str(_paths.NOX_ENVDIR_PATH))
 
 
@@ -216,12 +216,11 @@ class NoxConfig(BaseToolConfig):
 class MypyConfig(BaseToolConfig):
     table_path: ClassVar[str] = "tool.mypy"
 
-    ignore_missing_imports: bool | None = None
     check_untyped_defs: bool | None = None
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
-        return cls(ignore_missing_imports=True, check_untyped_defs=True)
+    def create_recommended(cls) -> Self:
+        return cls(check_untyped_defs=True)
 
     def extra_toml(self, project: ProjectConfig) -> dict[str, Any]:
         versions = project.pinned_versions
@@ -236,7 +235,7 @@ class PyrightConfig(BaseToolConfig):
     table_path: ClassVar[str] = "tool.pyright"
 
     @classmethod
-    def create_kitchen_sink(cls) -> Self:
+    def create_recommended(cls) -> Self:
         return cls()
 
     def extra_toml(self, project: ProjectConfig) -> dict[str, Any]:

pyprojkit-0.7.0/src/pyprojkit/py.typed

@@ -0,0 +1 @@
+