Add import-linter (#50)

pyproject.toml

@@ -33,6 +33,7 @@ dev-dependencies = [
     "pytest-cov>=5.0.0",
     "gitpython>=3.1.43",
     "pre-commit>=4.0.1",
+    "import-linter>=2.1",
 ]
 
 [tool.ruff]
@@ -52,3 +53,19 @@ addopts = [
 [tool.coverage.run]
 source = ["src"]
 omit = ["*/pytest-of-*/*"]
+
+[tool.importlinter]
+root_packages = ["usethis"]
+
+[[tool.importlinter.contracts]]
+name = "Modular Design"
+type = "layers"
+layers = [
+    "__main__",
+    "_interface",
+    "_tool",
+    "_integrations",
+    "_utils"
+]
+containers=["usethis"]
+exhaustive=true

src/usethis/__init__.py

@@ -1,6 +0,0 @@
-import typer
-from rich.console import Console
-
-console = Console()
-
-offline_opt = typer.Option(False, "--offline", help="Disable network access")

src/usethis/__main__.py

@@ -1,16 +1,18 @@
 import typer
 
-import usethis.browse
-import usethis.ci
-import usethis.tool
+import usethis._interface.browse
+import usethis._interface.ci
+import usethis._interface.tool
 
 app = typer.Typer(
     help=(
         "🤖 Automate Python package and project setup tasks that are otherwise "
         "performed manually."
     )
 )
-app.add_typer(usethis.tool.app, name="tool")
-app.add_typer(usethis.browse.app, name="browse")
-app.add_typer(usethis.ci.app, name="ci")
+app.add_typer(usethis._interface.tool.app, name="tool")
+app.add_typer(usethis._interface.browse.app, name="browse")
+app.add_typer(usethis._interface.ci.app, name="ci")
 app(prog_name="usethis")
+
+__all__ = ["app"]

src/usethis/_console.py

@@ -0,0 +1,6 @@
+import typer
+from rich.console import Console
+
+console = Console()
+
+offline_opt = typer.Option(False, "--offline", help="Disable network access")

src/usethis/_bitbucket/cache.py → src/usethis/_integrations/bitbucket/cache.py

@@ -2,7 +2,7 @@
 
 from pydantic import BaseModel
 
-from usethis._yaml import edit_yaml, load_yaml
+from usethis._utils._yaml import edit_yaml, load_yaml
 
 
 class Cache(BaseModel):

src/usethis/_bitbucket/config.py → src/usethis/_integrations/bitbucket/config.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from usethis import console
+from usethis._console import console
 
 _YAML_CONTENTS = """\
 image: atlassian/default-image:3

src/usethis/_bitbucket/steps.py → src/usethis/_integrations/bitbucket/steps.py

@@ -3,8 +3,8 @@
 
 from pydantic import BaseModel
 
-from usethis._bitbucket.cache import Cache, add_cache
-from usethis._yaml import edit_yaml
+from usethis._integrations.bitbucket.cache import Cache, add_cache
+from usethis._utils._yaml import edit_yaml
 
 
 class StepRef(BaseModel):

src/usethis/_pre_commit/core.py → src/usethis/_integrations/pre_commit/core.py

@@ -1,8 +1,8 @@
 import subprocess
 from pathlib import Path
 
-from usethis import console
-from usethis._github.tags import GitHubTagError, get_github_latest_tag
+from usethis._console import console
+from usethis._integrations.github.tags import GitHubTagError, get_github_latest_tag
 
 _YAML_CONTENTS_TEMPLATE = """\
 repos:

src/usethis/_pre_commit/hooks.py → src/usethis/_integrations/pre_commit/hooks.py

@@ -3,8 +3,8 @@
 
 import ruamel.yaml
 
-from usethis._pre_commit.config import PreCommitRepoConfig
-from usethis._yaml import edit_yaml
+from usethis._integrations.pre_commit.config import PreCommitRepoConfig
+from usethis._utils._yaml import edit_yaml
 
 _HOOK_ORDER = [
     "validate-pyproject",

src/usethis/_pyproject/core.py → src/usethis/_integrations/pyproject/core.py

@@ -2,7 +2,10 @@
 
 import mergedeep
 
-from usethis._pyproject.io import read_pyproject_toml, write_pyproject_toml
+from usethis._integrations.pyproject.io import (
+    read_pyproject_toml,
+    write_pyproject_toml,
+)
 
 
 class ConfigValueAlreadySetError(ValueError):

src/usethis/_pyproject/requires_python.py → src/usethis/_integrations/pyproject/requires_python.py

@@ -1,6 +1,6 @@
 from packaging.specifiers import SpecifierSet
 
-from usethis._pyproject.io import read_pyproject_toml
+from usethis._integrations.pyproject.io import read_pyproject_toml
 
 MIN_MAJOR_PY3 = 7  # Any earlier and uv won't support the executable.
 MAX_MAJOR_PY3 = 13

src/usethis/_pytest/core.py → src/usethis/_integrations/pytest/core.py

@@ -1,7 +1,7 @@
 import shutil
 from pathlib import Path
 
-from usethis import console
+from usethis._console import console
 
 
 def add_pytest_dir() -> None:

src/usethis/_ruff/rules.py → src/usethis/_integrations/ruff/rules.py

@@ -1,5 +1,5 @@
-from usethis import console
-from usethis._pyproject.core import (
+from usethis._console import console
+from usethis._integrations.pyproject.core import (
     append_config_list,
     get_config_value,
     remove_from_config_list,

src/usethis/_uv/deps.py → src/usethis/_integrations/uv/deps.py

@@ -4,8 +4,8 @@
 from packaging.requirements import Requirement
 from pydantic import TypeAdapter
 
-from usethis import console
-from usethis._pyproject.io import read_pyproject_toml
+from usethis._console import console
+from usethis._integrations.pyproject.io import read_pyproject_toml
 
 
 def get_dev_deps() -> list[str]:

src/usethis/_interface/__init__.py

@@ -0,0 +1,3 @@
+import typer
+
+offline_opt = typer.Option(False, "--offline", help="Disable network access")

src/usethis/browse.py → src/usethis/_interface/browse.py

@@ -1,6 +1,6 @@
 import typer
 
-from usethis import console
+from usethis._console import console
 
 app = typer.Typer(help="Visit important project-related web pages.")
 

src/usethis/ci.py → src/usethis/_interface/ci.py

@@ -2,13 +2,16 @@
 
 import typer
 
-from usethis import console, offline_opt
-from usethis._bitbucket.config import (
+from usethis._console import console
+from usethis._integrations.bitbucket.config import (
     add_bitbucket_pipeline_config,
     remove_bitbucket_pipeline_config,
 )
-from usethis._bitbucket.steps import Step, StepRef, add_steps
-from usethis._pyproject.requires_python import get_supported_major_python_versions
+from usethis._integrations.bitbucket.steps import Step, StepRef, add_steps
+from usethis._integrations.pyproject.requires_python import (
+    get_supported_major_python_versions,
+)
+from usethis._interface import offline_opt
 from usethis._tool import PreCommitTool, PytestTool
 
 app = typer.Typer(help="Add config for Continuous Integration (CI) pipelines.")

src/usethis/tool.py → src/usethis/_interface/tool.py

@@ -2,17 +2,18 @@
 
 import typer
 
-from usethis import console, offline_opt
-from usethis._pre_commit.core import (
+from usethis._console import console
+from usethis._integrations.pre_commit.core import (
     add_pre_commit_config,
     install_pre_commit,
     remove_pre_commit_config,
     uninstall_pre_commit,
 )
-from usethis._pytest.core import add_pytest_dir, remove_pytest_dir
-from usethis._ruff.rules import deselect_ruff_rules, select_ruff_rules
+from usethis._integrations.pytest.core import add_pytest_dir, remove_pytest_dir
+from usethis._integrations.ruff.rules import deselect_ruff_rules, select_ruff_rules
+from usethis._integrations.uv.deps import add_dev_deps, remove_dev_deps
+from usethis._interface import offline_opt
 from usethis._tool import ALL_TOOLS, DeptryTool, PreCommitTool, PytestTool, RuffTool
-from usethis._uv.deps import add_dev_deps, remove_dev_deps
 
 app = typer.Typer(help="Add and configure development tools, e.g. linters.")
 

src/usethis/_tool.py

@@ -2,23 +2,23 @@
 from pathlib import Path
 from typing import Protocol
 
-from usethis import console
-from usethis._pre_commit.config import HookConfig, PreCommitRepoConfig
-from usethis._pre_commit.core import add_pre_commit_config
-from usethis._pre_commit.hooks import (
+from usethis._console import console
+from usethis._integrations.pre_commit.config import HookConfig, PreCommitRepoConfig
+from usethis._integrations.pre_commit.core import add_pre_commit_config
+from usethis._integrations.pre_commit.hooks import (
     add_hook,
     get_hook_names,
     remove_hook,
 )
-from usethis._pyproject.config import PyProjectConfig
-from usethis._pyproject.core import (
+from usethis._integrations.pyproject.config import PyProjectConfig
+from usethis._integrations.pyproject.core import (
     ConfigValueAlreadySetError,
     ConfigValueMissingError,
     remove_config_value,
     set_config_value,
 )
-from usethis._pyproject.io import read_pyproject_toml
-from usethis._uv.deps import is_dep_used
+from usethis._integrations.pyproject.io import read_pyproject_toml
+from usethis._integrations.uv.deps import is_dep_used
 
 
 class Tool(Protocol):

tests/usethis/_bitbucket/test_cache.py → tests/usethis/_integrations/bitbucket/test_cache.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
-from usethis._bitbucket.cache import Cache, add_cache, get_caches
-from usethis._test import change_cwd
+from usethis._integrations.bitbucket.cache import Cache, add_cache, get_caches
+from usethis._utils._test import change_cwd
 
 
 class TestAddCache:

tests/usethis/_bitbucket/test_steps.py → tests/usethis/_integrations/bitbucket/test_steps.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
-from usethis._bitbucket.steps import Step, add_steps
-from usethis._test import change_cwd
+from usethis._integrations.bitbucket.steps import Step, add_steps
+from usethis._utils._test import change_cwd
 
 
 class TestAddStep:

tests/usethis/_github/test_tags.py → tests/usethis/_integrations/github/test_tags.py

@@ -1,7 +1,7 @@
 import pytest
 import requests
 
-from usethis._github.tags import (
+from usethis._integrations.github.tags import (
     GitHubTagError,
     NoGitHubTagsFoundError,
     get_github_latest_tag,

tests/usethis/_pre_commit/test_core.py → tests/usethis/_integrations/pre_commit/test_core.py

@@ -3,12 +3,12 @@
 import pytest
 import requests
 
-from usethis._pre_commit.core import (
+from usethis._integrations.pre_commit.core import (
     _VALIDATEPYPROJECT_VERSION,
     add_pre_commit_config,
     remove_pre_commit_config,
 )
-from usethis._test import change_cwd
+from usethis._utils._test import change_cwd
 
 
 class TestAddPreCommitConfig:

tests/usethis/_pre_commit/test_hooks.py → tests/usethis/_integrations/pre_commit/test_hooks.py

@@ -2,14 +2,14 @@
 
 import pytest
 
-from usethis._pre_commit.config import HookConfig, PreCommitRepoConfig
-from usethis._pre_commit.hooks import (
+from usethis._integrations.pre_commit.config import HookConfig, PreCommitRepoConfig
+from usethis._integrations.pre_commit.hooks import (
     DuplicatedHookNameError,
     add_hook,
     get_hook_names,
     remove_hook,
 )
-from usethis._test import change_cwd
+from usethis._utils._test import change_cwd
 
 
 class TestAddHook:

tests/usethis/_pyproject/test_core.py → tests/usethis/_integrations/pyproject/test_core.py

@@ -3,16 +3,16 @@
 
 import pytest
 
-from usethis._pyproject.core import (
+from usethis._integrations.pyproject.core import (
     ConfigValueAlreadySetError,
     ConfigValueMissingError,
     append_config_list,
     get_config_value,
     remove_config_value,
     set_config_value,
 )
-from usethis._pyproject.io import PyProjectTOMLNotFoundError
-from usethis._test import change_cwd
+from usethis._integrations.pyproject.io import PyProjectTOMLNotFoundError
+from usethis._utils._test import change_cwd
 
 
 class TestGetConfigValue:

tests/usethis/_pyproject/test_requires_python.py → tests/usethis/_integrations/pyproject/test_requires_python.py

@@ -5,14 +5,14 @@
 import requests
 from packaging.specifiers import SpecifierSet
 
-from usethis._pyproject.io import PyProjectTOMLNotFoundError
-from usethis._pyproject.requires_python import (
+from usethis._integrations.pyproject.io import PyProjectTOMLNotFoundError
+from usethis._integrations.pyproject.requires_python import (
     MAX_MAJOR_PY3,
     MissingRequiresPythonError,
     get_requires_python,
     get_supported_major_python_versions,
 )
-from usethis._test import change_cwd
+from usethis._utils._test import change_cwd
 
 
 class TestMaxMajorPy3:

tests/usethis/_pytest/test_core.py → tests/usethis/_integrations/pytest/test_core.py

@@ -2,8 +2,8 @@
 
 import pytest
 
-from usethis._pytest.core import add_pytest_dir, remove_pytest_dir
-from usethis._test import change_cwd
+from usethis._integrations.pytest.core import add_pytest_dir, remove_pytest_dir
+from usethis._utils._test import change_cwd
 
 
 class TestAddPytestDir:

tests/usethis/_ruff/test_rules.py → tests/usethis/_integrations/ruff/test_rules.py

@@ -2,9 +2,13 @@
 
 import pytest
 
-from usethis._pyproject.io import PyProjectTOMLNotFoundError
-from usethis._ruff.rules import deselect_ruff_rules, get_ruff_rules, select_ruff_rules
-from usethis._test import change_cwd
+from usethis._integrations.pyproject.io import PyProjectTOMLNotFoundError
+from usethis._integrations.ruff.rules import (
+    deselect_ruff_rules,
+    get_ruff_rules,
+    select_ruff_rules,
+)
+from usethis._utils._test import change_cwd
 
 
 class TestSelectRuffRules:

tests/usethis/_uv/deps.py → tests/usethis/_integrations/uv/deps.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
-from usethis._test import change_cwd
-from usethis._uv.deps import get_dev_deps
+from usethis._integrations.uv.deps import get_dev_deps
+from usethis._utils._test import change_cwd
 
 
 class TestGetDevDeps: