Skip to content

projects ¤

Functions:

new_public_and_insiders_github_projects ¤

new_public_and_insiders_github_projects(
    *,
    public_namespace: str,
    public_name: str,
    description: str,
    public_repo_path: str | Path,
    insiders_namespace: str | None = None,
    insiders_name: str | None = None,
    insiders_repo_path: str | Path,
    github_username: str | None = None,
    copier_template: str | None = None,
    copier_template_answers: dict[str, Any] | None = None,
    post_creation_command: str | list[str] | None = None
) -> None

Create a new Insiders project on GitHub (public and private repositories).

Parameters:

  • public_namespace (str) –

    Namespace of the public repository.

  • public_name (str) –

    Name of the public repository.

  • description (str) –

    Shared description.

  • public_repo_path (str | Path) –

    Local path in which to clone the public repository.

  • insiders_namespace (str | None, default: None ) –

    Namespace of the insiders repository. Defaults to the public namespace.

  • insiders_name (str | None, default: None ) –

    Name of the insiders repository. Defaults to the public name.

  • insiders_repo_path (str | Path) –

    Local path in which to clone the insiders repository.

  • github_username (str | None, default: None ) –

    Username. Defaults to the public namespace value.

  • copier_template (str | None, default: None ) –

    Copier template to initialize the local insiders repository with.

  • copier_template_answers (dict[str, Any] | None, default: None ) –

    Answers to the Copier template questions.

  • post_creation_command (str | list[str] | None, default: None ) –

    Command to run after creating the public repository.