Skip to content

github ¤

GitHub integration.

Functions:

  • new_project –

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

new_project ¤

new_project(
    *,
    namespace: str,
    repo: str,
    description: str,
    repo_path: str | Path,
    insiders_repo_path: str | Path,
    insiders_namespace: str | None = None,
    insiders_repo: str | None = None,
    username: str | None = None,
    copier_template: str | None = None
) -> None

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

Parameters:

  • namespace (str) –

    Namespace of the public repository.

  • repo (str) –

    Name of the public repository.

  • description (str) –

    Shared description.

  • repo_path (str | Path) –

    Local path in which to clone the public repository.

  • insiders_repo_path (str | Path) –

    Local path in which to clone the insiders repository.

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

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

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

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

  • 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.