add management command for importing an existing installation

Author: joshuadavidthomas

Justfile

@@ -29,6 +29,23 @@ lint:
 lock *ARGS:
     uv lock {{ ARGS }}
 
+manage *COMMAND:
+    #!/usr/bin/env python
+    import sys
+
+    try:
+        from django.conf import settings
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+
+    settings.configure(INSTALLED_APPS=["django_github_app"])
+    execute_from_command_line(sys.argv + "{{ COMMAND }}".split(" "))
+
 test *ARGS:
     @just nox test {{ ARGS }}
 

pyproject.toml

@@ -49,9 +49,10 @@ classifiers = [
 ]
 dependencies = [
   "cachetools>=5.5.0",
+  "django-typer[rich]>=2.4.0",
   "django>=4.2",
   "gidgethub>=5.3.0",
-  "httpx>=0.27.2"
+  "httpx>=0.27.2",
 ]
 description = "A Django toolkit for GitHub Apps with batteries included."
 dynamic = ["version"]

src/django_github_app/github.py

@@ -85,7 +85,11 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
 
 class GitHubAPIEndpoint(Enum):
     INSTALLATION_REPOS = "/installation/repositories"
+    ORG_INSTALLATIONS = "/orgs/{org}/installations"
+    REPO_INSTALLATION = "/repos/{owner}/{repo}/installation"
+    REPO_ISSUE = "/repos/{owner}/{repo}/issues/{issue_number}"
     REPO_ISSUES = "/repos/{owner}/{repo}/issues"
+    USER_INSTALLATION = "/users/{username}/installation"
 
 
 @dataclass(frozen=True, slots=True)

src/django_github_app/management/__init__.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+from typing import Annotated
+from typing import Literal
+
+from asgiref.sync import async_to_sync
+from django_typer.management import Typer
+from typer import Option
+
+from django_github_app.conf import app_settings
+from django_github_app.github import AsyncGitHubAPI
+from django_github_app.github import GitHubAPIEndpoint
+from django_github_app.github import GitHubAPIUrl
+from django_github_app.models import Installation
+from django_github_app.models import Repository
+
+cli = Typer(help="Manage your GitHub App")
+
+
+async def get_installation(name, installation_id, oauth_token):
+    async with AsyncGitHubAPI(app_settings.SLUG) as gh:
+        gh.oauth_token = oauth_token
+        endpoint = GitHubAPIUrl(
+            GitHubAPIEndpoint.ORG_INSTALLATIONS,
+            {"org": name},
+        )
+        data = await gh.getitem(endpoint.full_url)
+        for installation in data.get("installations"):
+            if installation["id"] == installation_id:
+                return installation
+        return None
+
+
+async def get_repos(installation):
+    async with AsyncGitHubAPI(installation.app_slug) as gh:
+        gh.oauth_token = await installation.aget_access_token(gh)
+        url = GitHubAPIUrl(GitHubAPIEndpoint.INSTALLATION_REPOS)
+        repos = [
+            repo async for repo in gh.getiter(url.full_url, iterable_key="repositories")
+        ]
+        print(f"{repos=}")
+
+
+@cli.command()
+def import_app(
+    name: Annotated[
+        str,
+        Option(
+            help="The name of the user, repository (owner/repo), or organization the GitHub App is installed on"
+        ),
+    ],
+    type: Annotated[
+        Literal["user", "repo", "org"],
+        Option(help="The type of account the GitHub App is installed on"),
+    ],
+    installation_id: Annotated[
+        int, Option(help="The installation id of the existing GitHub App")
+    ],
+    oauth_token: Annotated[
+        str, Option(help="PAT for accessing GitHub App installations")
+    ],
+):
+    """
+    Import an existing GitHub App to database Models.
+    """
+    installation_data = async_to_sync(get_installation)(
+        name, installation_id, oauth_token
+    )
+    if installation_data:
+        installation = Installation.objects.create_from_gh_data(installation_data)
+        repository_data = installation.get_repos()
+        Repository.objects.create_from_gh_data(repository_data)

src/django_github_app/management/commands/__init__.py

@@ -14,6 +14,7 @@
 from django.utils.decorators import method_decorator
 from django.views.decorators.csrf import csrf_exempt
 from django.views.generic import View
+from gidgethub.abc import GitHubAPI
 from gidgethub.routing import Router as GidgetHubRouter
 from gidgethub.sansio import Event
 
@@ -25,7 +26,7 @@
 from .models import Installation
 from .routing import GitHubRouter
 
-GitHubAPIType = TypeVar("GitHubAPIType", AsyncGitHubAPI, SyncGitHubAPI)
+GitHubAPIType = TypeVar("GitHubAPIType", AsyncGitHubAPI, GitHubAPI, SyncGitHubAPI)
 
 
 class BaseWebhookView(View, ABC, Generic[GitHubAPIType]):