ChatPyPI 0.1.1__py3-none-any.whl

chatpypi/__init__.py

@@ -0,0 +1,43 @@
+"""ChatPyPI package lifecycle helpers.
+
+ChatPyPI provides importable Python APIs for scaffolding, building, checking,
+probing, and uploading Python package distributions. The ``chatpypi`` CLI is a
+thin adapter over these APIs.
+"""
+
+from .main import (
+    CommandResult,
+    DoctorCheck,
+    ProjectMetadata,
+    PyPICommandError,
+    RepositoryCheck,
+    ScaffoldResult,
+    build_package,
+    check_distributions,
+    check_repository_conflicts,
+    normalize_module_name,
+    read_project_metadata,
+    resolve_dist_dir,
+    scaffold_package,
+    upload_distributions,
+)
+
+__all__ = [
+    "__version__",
+    "CommandResult",
+    "DoctorCheck",
+    "ProjectMetadata",
+    "PyPICommandError",
+    "RepositoryCheck",
+    "ScaffoldResult",
+    "build_package",
+    "check_distributions",
+    "check_repository_conflicts",
+    "normalize_module_name",
+    "read_project_metadata",
+    "resolve_dist_dir",
+    "scaffold_package",
+    "upload_distributions",
+]
+
+__version__ = "0.1.1"

chatpypi/cli.py

@@ -0,0 +1,541 @@
+from __future__ import annotations
+
+from pathlib import Path
+import subprocess
+import sys
+
+import click
+
+from chatstyle import INTERACTIVE_OPTION_HELP
+from chatstyle import (
+    abort_if_force_without_tty,
+    abort_if_missing_without_tty,
+    ask_confirm,
+    ask_select,
+    ask_text,
+    resolve_interactive_mode,
+)
+
+from chatpypi.main import (
+    PyPICommandError,
+    _ensure_empty_or_missing,
+    build_package,
+    check_distributions,
+    check_repository_conflicts,
+    read_project_metadata,
+    resolve_dist_dir,
+    scaffold_package,
+    upload_distributions,
+)
+
+
+def _project_options(func):
+    func = click.option(
+        "--dist-dir",
+        type=click.Path(path_type=Path, file_okay=False),
+        default=None,
+        help="Distribution directory. Defaults to <project-dir>/dist.",
+    )(func)
+    func = click.option(
+        "--project-dir",
+        type=click.Path(path_type=Path, file_okay=False),
+        default=Path("."),
+        show_default=True,
+        help="Project directory containing pyproject.toml.",
+    )(func)
+    return func
+
+
+def _echo_result_output(result) -> None:
+    stdout = result.stdout.strip()
+    stderr = result.stderr.strip()
+    if stdout:
+        click.echo(stdout)
+    if stderr:
+        click.echo(stderr, err=True)
+
+
+def _print_files(files: list[Path], title: str) -> None:
+    click.echo(title)
+    for path in files:
+        click.echo(f"- {path}")
+
+
+def _raise_click_error(exc: Exception) -> None:
+    raise click.ClickException(str(exc)) from exc
+
+
+def _normalize_optional_text(value: str | None) -> str | None:
+    if value is None:
+        return None
+    value = value.strip()
+    return value or None
+
+
+def _resolve_init_inputs(
+    *,
+    name: str | None,
+    description: str | None,
+    initial_version: str,
+    requires_python: str,
+    license_name: str,
+    author: str | None,
+    email: str | None,
+    project_dir: Path | None,
+    template: str = "default",
+) -> tuple[str, str | None, str, str, str, str | None, str | None, Path]:
+    package_name = _normalize_optional_text(name)
+    if not package_name and project_dir is not None and project_dir.name:
+        package_name = project_dir.name
+    if not package_name:
+        raise click.ClickException(
+            "Package name is required. Pass NAME or --project-dir."
+        )
+
+    target_dir = (project_dir or Path(package_name)).resolve()
+    return (
+        package_name,
+        _normalize_optional_text(description) or f"{package_name} package",
+        initial_version or "0.1.0",
+        requires_python or _default_requires_python(template),
+        license_name or "MIT",
+        _normalize_optional_text(author),
+        _normalize_optional_text(email),
+        target_dir,
+    )
+
+
+def _default_requires_python(template: str) -> str:
+    if template == "chatarch":
+        return ">=3.10"
+    return ">=3.9"
+
+
+def _option_was_default(name: str) -> bool:
+    ctx = click.get_current_context(silent=True)
+    if not ctx:
+        return False
+    try:
+        return ctx.get_parameter_source(name) == click.core.ParameterSource.DEFAULT
+    except Exception:
+        return False
+
+
+def _is_name_missing(name: str | None, project_dir: Path | None) -> bool:
+    package_name = _normalize_optional_text(name)
+    return not package_name and not (project_dir is not None and project_dir.name)
+
+
+def _read_git_config(key: str) -> str | None:
+    try:
+        result = subprocess.run(
+            ["git", "config", "--get", key],
+            check=False,
+            capture_output=True,
+            text=True,
+        )
+    except Exception:
+        return None
+    if result.returncode != 0:
+        return None
+    value = result.stdout.strip()
+    return value or None
+
+
+def _resolve_project_dir(project_dir: Path) -> Path:
+    return project_dir.resolve()
+
+
+def _resolve_project_and_dist_dirs(
+    project_dir: Path, dist_dir: Path | None
+) -> tuple[Path, Path]:
+    resolved_project_dir = _resolve_project_dir(project_dir)
+    resolved_dist_dir = resolve_dist_dir(
+        resolved_project_dir,
+        dist_dir.resolve() if dist_dir else None,
+    )
+    return resolved_project_dir, resolved_dist_dir
+
+
+@click.group(name="chatpypi")
+def cli():
+    """Python package scaffold/build/check/upload helpers."""
+    pass
+
+
+@cli.command(name="init")
+@click.argument("name", required=False)
+@click.option(
+    "-t",
+    "--template",
+    type=click.Choice(["default", "chatarch"]),
+    default="default",
+    show_default=True,
+    help="Project scaffold template.",
+)
+@click.option("--email", default=None, help="Author email to record in pyproject.toml.")
+@click.option("--author", default=None, help="Author name to record in pyproject.toml.")
+@click.option(
+    "--license",
+    "license_name",
+    default="MIT",
+    show_default=True,
+    help="Project license template: MIT, Apache-2.0, BSD-3-Clause, GPL-3.0-only, or Proprietary.",
+)
+@click.option(
+    "--version",
+    "initial_version",
+    default="0.1.0",
+    show_default=True,
+    help="Initial package version written to src/<module>/__init__.py.",
+)
+@click.option(
+    "--python",
+    "requires_python",
+    default=">=3.9",
+    show_default=True,
+    help="Supported Python version specifier.",
+)
+@click.option("--description", default=None, help="Project description.")
+@click.option(
+    "--project-dir",
+    type=click.Path(path_type=Path, file_okay=False),
+    default=None,
+    help="Target directory to create. Defaults to ./{name}.",
+)
+@click.option(
+    "--with-mkdocs/--without-mkdocs",
+    "include_mkdocs",
+    default=None,
+    help="Create mkdocs files for chatarch template. Defaults to on for chatarch.",
+)
+@click.option(
+    "--with-workflows/--without-workflows",
+    "include_workflows",
+    default=None,
+    help="Create GitHub workflow files for chatarch template. Defaults to on for chatarch.",
+)
+@click.option(
+    "--with-chatenv-provider/--without-chatenv-provider",
+    "include_chatenv_provider",
+    default=False,
+    show_default=True,
+    help="Create ChatEnv provider config.py and chatenv.configs entry point for chatarch template.",
+)
+@click.option(
+    "--chatenv-provider-name",
+    default=None,
+    help="Entry point name for --with-chatenv-provider. Defaults to the module name.",
+)
+@click.option(
+    "--interactive/--no-interactive",
+    "interactive",
+    "-i/-I",
+    default=None,
+    help=INTERACTIVE_OPTION_HELP,
+)
+def init(
+    name: str | None,
+    template: str,
+    description: str | None,
+    initial_version: str,
+    requires_python: str,
+    license_name: str,
+    author: str | None,
+    email: str | None,
+    project_dir: Path | None,
+    include_mkdocs: bool | None,
+    include_workflows: bool | None,
+    include_chatenv_provider: bool,
+    chatenv_provider_name: str | None,
+    interactive: bool | None,
+):
+    """Scaffold a minimal src-layout Python package."""
+    if _option_was_default("requires_python"):
+        requires_python = _default_requires_python(template)
+
+    missing_required = _is_name_missing(name, project_dir)
+    usage = (
+        "Usage: chatpypi init [NAME] [-t default|chatarch] [--project-dir PATH] "
+        "[--description TEXT] [--version TEXT] [--python TEXT] [--license TEXT] "
+        "[--author TEXT] [--email TEXT] [-i|-I]"
+    )
+    resolution = resolve_interactive_mode(
+        interactive=interactive,
+        auto_prompt_condition=missing_required,
+    )
+    interactive = resolution.interactive
+    can_prompt = resolution.can_prompt
+    force_interactive = resolution.force_interactive
+    need_prompt = resolution.need_prompt
+    abort_if_force_without_tty(force_interactive, can_prompt, usage)
+    abort_if_missing_without_tty(
+        missing_required=missing_required,
+        interactive=interactive,
+        can_prompt=can_prompt,
+        message="Package name is required. Pass NAME or --project-dir.",
+        usage=usage,
+    )
+
+    if need_prompt:
+        template = ask_select(
+            "选择模板",
+            choices=[
+                "default - minimal Python package",
+                "chatarch - ChatArch CLI/docs/tests/automation scaffold",
+            ],
+        ).split(" - ", 1)[0]
+        name_default = _normalize_optional_text(name) or (
+            project_dir.name if project_dir is not None and project_dir.name else ""
+        )
+        name = ask_text("package_name", default=name_default)
+        normalized_name = _normalize_optional_text(name)
+        if not normalized_name:
+            raise click.ClickException(
+                "Package name is required. Pass NAME or --project-dir."
+            )
+
+        project_dir_default = str(project_dir or Path(normalized_name))
+        project_dir = Path(
+            ask_text("project_dir", default=project_dir_default)
+        ).expanduser()
+        try:
+            _ensure_empty_or_missing(project_dir)
+        except PyPICommandError as exc:
+            _raise_click_error(exc)
+        description = ask_text(
+            "description",
+            default=_normalize_optional_text(description)
+            or f"{normalized_name} package",
+        )
+        initial_version = ask_text("version", default=initial_version or "0.1.0")
+        if _option_was_default("requires_python"):
+            requires_python = _default_requires_python(template)
+        requires_python = ask_text("requires_python", default=requires_python)
+        license_name = ask_text("license", default=license_name or "MIT")
+        if include_mkdocs is None and template == "chatarch":
+            include_mkdocs = ask_confirm(
+                "Create mkdocs documentation files?",
+                default=True,
+            )
+        elif include_mkdocs is None:
+            include_mkdocs = False
+        if include_workflows is None and template == "chatarch":
+            include_workflows = ask_confirm(
+                "Create GitHub workflow files?",
+                default=True,
+            )
+        elif include_workflows is None:
+            include_workflows = False
+        author = ask_text(
+            "author",
+            default=_normalize_optional_text(author)
+            or _read_git_config("user.name")
+            or "",
+        )
+        email = ask_text(
+            "email",
+            default=_normalize_optional_text(email)
+            or _read_git_config("user.email")
+            or "",
+        )
+
+    (
+        package_name,
+        description,
+        initial_version,
+        requires_python,
+        license_name,
+        author,
+        email,
+        target_dir,
+    ) = _resolve_init_inputs(
+        name=name,
+        description=description,
+        initial_version=initial_version,
+        requires_python=requires_python,
+        license_name=license_name,
+        author=author,
+        email=email,
+        project_dir=project_dir,
+        template=template,
+    )
+    if chatenv_provider_name and not include_chatenv_provider:
+        raise click.ClickException(
+            "--chatenv-provider-name requires --with-chatenv-provider."
+        )
+    if include_chatenv_provider and template != "chatarch":
+        raise click.ClickException(
+            "--with-chatenv-provider is only supported by the chatarch template."
+        )
+    try:
+        result = scaffold_package(
+            package_name=package_name,
+            project_dir=target_dir,
+            initial_version=initial_version,
+            description=description,
+            requires_python=requires_python,
+            license_name=license_name,
+            author=author,
+            email=email,
+            template=template,
+            include_mkdocs=include_mkdocs,
+            include_workflows=include_workflows,
+            include_chatenv_provider=include_chatenv_provider,
+            chatenv_provider_name=chatenv_provider_name,
+        )
+    except PyPICommandError as exc:
+        _raise_click_error(exc)
+
+    click.echo(f"Created Python package scaffold: {result.package_name}")
+    click.echo(f"project_dir={result.project_dir}")
+    click.echo(f"module_name={result.module_name}")
+    _print_files(result.created_files, "Created files:")
+
+
+@cli.command(name="build")
+@click.option("--wheel", is_flag=True, help="Build wheel only.")
+@click.option("--sdist", is_flag=True, help="Build source distribution only.")
+@click.option(
+    "--clean/--no-clean",
+    default=True,
+    show_default=True,
+    help="Clean old files in dist directory first.",
+)
+@_project_options
+def build(
+    project_dir: Path, dist_dir: Path | None, clean: bool, sdist: bool, wheel: bool
+):
+    """Build wheel and/or source distribution with python -m build."""
+    project_dir, dist_dir = _resolve_project_and_dist_dirs(project_dir, dist_dir)
+    click.echo(f"Building distributions from {project_dir} into {dist_dir}...")
+    try:
+        result, files = build_package(
+            project_dir,
+            dist_dir,
+            clean=clean,
+            sdist=sdist,
+            wheel=wheel,
+        )
+    except PyPICommandError as exc:
+        _raise_click_error(exc)
+    _echo_result_output(result)
+    _print_files(files, "Built distributions:")
+
+
+@cli.command(name="check")
+@click.option(
+    "--strict", is_flag=True, help="Fail on warnings reported by twine check."
+)
+@_project_options
+def check(project_dir: Path, dist_dir: Path | None, strict: bool):
+    """Validate built distributions with twine check."""
+    project_dir, dist_dir = _resolve_project_and_dist_dirs(project_dir, dist_dir)
+    try:
+        result, files = check_distributions(
+            project_dir,
+            dist_dir,
+            strict=strict,
+        )
+    except PyPICommandError as exc:
+        _raise_click_error(exc)
+    _echo_result_output(result)
+    _print_files(files, "Checked distributions:")
+
+
+@cli.command(name="upload")
+@click.option(
+    "--skip-existing", is_flag=True, help="Pass --skip-existing to twine upload."
+)
+@_project_options
+def upload(project_dir: Path, dist_dir: Path | None, skip_existing: bool):
+    """Upload built distributions with the default twine upload behavior."""
+    project_dir, dist_dir = _resolve_project_and_dist_dirs(project_dir, dist_dir)
+    click.echo(f"Uploading distributions from {dist_dir} with `twine upload`...")
+    try:
+        result, files = upload_distributions(
+            project_dir,
+            dist_dir,
+            skip_existing=skip_existing,
+        )
+    except PyPICommandError as exc:
+        _raise_click_error(exc)
+    _echo_result_output(result)
+    _print_files(files, "Uploaded distributions:")
+
+
+@cli.command(name="probe")
+@click.argument("package_name", required=False)
+@click.option(
+    "--repository-url",
+    default=None,
+    help="Custom repository URL. Overrides --repository.",
+)
+@click.option(
+    "--repository",
+    type=click.Choice(["testpypi", "pypi"]),
+    default="pypi",
+    show_default=True,
+    help="Target repository for exact project/version releaseability checks.",
+)
+@click.option(
+    "--project-dir",
+    type=click.Path(path_type=Path, file_okay=False),
+    default=Path("."),
+    show_default=True,
+    help="Project directory containing pyproject.toml for default metadata lookup.",
+)
+def probe(
+    project_dir: Path,
+    repository: str,
+    repository_url: str | None,
+    package_name: str | None,
+):
+    """Check whether an exact package name is available on PyPI."""
+    project_dir = _resolve_project_dir(project_dir)
+    try:
+        metadata = read_project_metadata(project_dir)
+    except PyPICommandError:
+        metadata = None
+
+    target_name = _normalize_optional_text(package_name) or (
+        metadata.name if metadata else None
+    )
+    if not target_name:
+        raise click.ClickException(
+            "Package name is required. Pass NAME or provide a readable pyproject.toml."
+        )
+
+    try:
+        repository_checks = check_repository_conflicts(
+            target_name,
+            repository=repository,
+            repository_url=repository_url,
+        )
+    except PyPICommandError as exc:
+        _raise_click_error(exc)
+
+    for item in repository_checks:
+        click.echo(f"[{item.status.upper()}] {item.label}: {item.detail}")
+        if item.hint:
+            click.echo(f"  hint: {item.hint}")
+    if any(item.status == "fail" for item in repository_checks):
+        raise click.ClickException("Repository conflict checks found blocking issues.")
+
+
+KNOWN_COMMANDS = {"init", "build", "check", "upload", "probe", "--help", "-h"}
+
+
+def main() -> None:
+    """Console-script entry point with chatpypi shortcut routing."""
+
+    args = sys.argv[1:]
+    if args:
+        first = args[0]
+        if first not in KNOWN_COMMANDS and not first.startswith("-"):
+            args = ["init", *args]
+    cli.main(args=args, prog_name="chatpypi")
+
+
+if __name__ == "__main__":
+    main()