Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions apps/misc/urls.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
from django.urls import path

from .views import recent_commits

app_name = "misc"

urlpatterns = [
path("github/<str:username>/commits/", recent_commits, name="github-recent-commits"),
]
46 changes: 46 additions & 0 deletions apps/misc/views.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import os

from django.http import JsonResponse
from django.views.decorators.http import require_GET

try:
# octokitpy client
from octokit import Octokit
except ImportError: # pragma: no cover
Octokit = None # type: ignore


@require_GET
def recent_commits(request, username: str):
"""
Return metadata for a user's most recent commits (up to 100) across GitHub.
Optional query params:
- per_page: number of commits to return (default 100, max 100)
"""
if Octokit is None:
return JsonResponse({"error": "octokitpy is not installed"}, status=500)

per_page = min(int(request.GET.get("per_page", 100)), 100)
token = os.environ.get("GITHUB_TOKEN")

# Initialize Octokit client (authenticated if token provided to raise rate limits)
if token:
client = Octokit(type="token", token=token)
else:
client = Octokit()

# Use the GitHub Search API for commits
# Query: search by author username, sorted by author date desc
# Note: Commit Search API historically required a preview accept header; octokitpy handles headers internally.
res = client.search.commits(
q=f"author:{username}",
sort="author-date",
order="desc",
per_page=per_page,
)

# Return the raw payload so the caller gets "all the metadata"
data = res.json # type: ignore[attr-defined]
# Keep it simple: forward the result from GitHub. Optionally, we could subset fields here.

return JsonResponse(data, safe=False)
1 change: 1 addition & 0 deletions conf/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

urlpatterns = [
path("", include("apps.users.urls.auth")),
path("api/", include("apps.misc.urls")),
path("admin/", admin.site.urls),
]

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ psycopg2-binary = "^2.8.4"
python = "^3.6"
redis = "^3.3.11"
sentry-sdk = "^0.14.1"
octokitpy = "^0.3.0"

[tool.poetry.dev-dependencies]
Werkzeug = "^0.16.0"
Expand Down