Initial commit for githubmodels.go

Author: Mehmet Aydin

.github/workflows/go.yml

@@ -0,0 +1,32 @@
+name: Go CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: 1.21 # or your preferred Go version
+
+    - name: Install dependencies
+      run: go mod tidy
+
+    - name: Build
+      run: go build ./...
+
+    - name: Run tests
+      run: go test -v ./...

.gitignore

@@ -0,0 +1,28 @@
+# Binaries
+/bin/
+/*.exe
+/*.exe~
+/*.dll
+/*.so
+/*.dylib
+
+# Build output
+/build/
+/out/
+
+# Vendor directory (optional, if you use Go modules you may not need this)
+vendor/
+
+# Editor files
+*.swp
+*.swo
+*.idea/
+*.vscode/
+*.DS_Store
+
+# Test output
+*.test
+coverage.out
+
+# Go dependency files (do NOT ignore go.mod or go.sum)
+# go.sum should be committed, go.mod too

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tigillo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,87 @@
+# githubmodels-go
+
+[![Go Reference](https://pkg.go.dev/badge/github.com/tigillo/githubmodels-go.svg)](https://pkg.go.dev/github.com/tigillo/githubmodels-go)
+
+`githubmodels-go` is a Go client library for interacting with the [GitHub Models API](https://docs.github.com/en/rest/models), inspired by the OpenAI Go SDK (`openai-go`).  
+It allows you to list models, perform chat/inference completions, and supports streaming responses using your `GITHUB_TOKEN` for authentication.
+
+---
+
+## Features
+
+- List available models in the GitHub Models catalog
+- Create chat completions (like OpenAI’s `ChatCompletion`)
+- Optional streaming support for real-time responses
+- Supports organization-scoped endpoints
+- Easy-to-use Go client interface
+
+---
+
+## Installation
+
+```bash
+go get github.com/tigillo/githubmodels-go
+```
+
+## Usage
+### Initialize Client
+```
+package main
+
+import (
+    "context"
+    "fmt"
+    "os"
+
+    githubmodels "github.com/tigillo/githubmodels-go/client"
+)
+
+func main() {
+    token := os.Getenv("GITHUB_TOKEN")
+    client := githubmodels.NewClient(token)
+
+    ctx := context.Background()
+    
+    // Example: list models
+    models, err := client.ListModels(ctx)
+    if err != nil {
+        panic(err)
+    }
+
+    for _, m := range models {
+        fmt.Println(m.ID, "-", m.Description)
+    }
+}
+```
+
+### Create Chat Completion
+```
+resp, err := client.ChatCompletion(ctx, githubmodels.ChatRequest{
+    Model: "github/code-chat",
+    Messages: []githubmodels.Message{
+        {Role: "user", Content: "Write a Go function to reverse a string"},
+    },
+})
+if err != nil {
+    panic(err)
+}
+
+fmt.Println(resp.Choices[0].Message.Content)
+```
+
+## Environment Variables
+
+The library uses the `GITHUB_TOKEN` environment variable by default for authentication.
+Ensure your token has the required scopes:
+
+ - `models:read` for catalog access
+ - `models:execute` for inference/chat completions
+
+## Contributing
+
+Contributions are welcome! Feel free to:
+ - Open issues for bugs or feature requests
+ - Submit pull requests for enhancements or fixes
+ - Add examples or tests
+
+

client/client.go

@@ -0,0 +1,97 @@
+package client
+
+import (
+	"bytes"
+	"context"
+	"encoding/json"
+	"fmt"
+	"net/http"
+
+	"github.com/tigillo/githubmodels-go/models"
+)
+
+// Client is the main GitHub Models API client
+type Client struct {
+	token   string
+	Client  *http.Client
+	BaseURL string // exported so tests can override
+}
+
+// NewClient creates a new GitHub Models API client
+func NewClient(token string) *Client {
+	return &Client{
+		token:   token,
+		Client:  http.DefaultClient,
+		BaseURL: "https://api.github.ai", // production default
+	}
+}
+
+// Model represents a GitHub Models API model
+type Model struct {
+	ID          string `json:"id"`
+	Description string `json:"description"`
+}
+
+// ListModels returns all available models from the catalog
+func (c *Client) ListModels(ctx context.Context) ([]Model, error) {
+	url := fmt.Sprintf("%s/catalog/models", c.BaseURL)
+	req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
+	if err != nil {
+		return nil, err
+	}
+	req.Header.Set("Authorization", "Bearer "+c.token)
+	req.Header.Set("Accept", "application/vnd.github+json")
+
+	resp, err := c.Client.Do(req)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		return nil, fmt.Errorf("unexpected status code: %d", resp.StatusCode)
+	}
+
+	var models []Model
+	if err := json.NewDecoder(resp.Body).Decode(&models); err != nil {
+		return nil, err
+	}
+
+	return models, nil
+}
+
+// ChatCompletion sends a chat completion request to GitHub Models API
+func (c *Client) ChatCompletion(ctx context.Context, reqData models.ChatRequest) (*models.ChatResponse, error) {
+	url := fmt.Sprintf("%s/inference/chat/completions", c.BaseURL)
+
+	bodyBytes, err := json.Marshal(reqData)
+	if err != nil {
+		return nil, err
+	}
+
+	req, err := http.NewRequestWithContext(ctx, "POST", url, bytes.NewReader(bodyBytes))
+	if err != nil {
+		return nil, err
+	}
+
+	req.Header.Set("Authorization", "Bearer "+c.token)
+	req.Header.Set("Accept", "application/vnd.github+json")
+	req.Header.Set("Content-Type", "application/json")
+
+	resp, err := c.Client.Do(req)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		return nil, fmt.Errorf("unexpected status code: %d", resp.StatusCode)
+	}
+
+	var chatResp models.ChatResponse
+	if err := json.NewDecoder(resp.Body).Decode(&chatResp); err != nil {
+		return nil, err
+	}
+
+	return &chatResp, nil
+}

client/client_test.go

@@ -0,0 +1,96 @@
+package client
+
+import (
+	"context"
+	"encoding/json"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/tigillo/githubmodels-go/models"
+)
+
+// Helper to create a test client pointing to a mock server
+func newTestClient(ts *httptest.Server) *Client {
+	return &Client{
+		token:   "test-token",
+		BaseURL: ts.URL,
+		Client:  ts.Client(),
+	}
+}
+
+func TestListModels(t *testing.T) {
+	// Mock response
+	mockModels := []models.Model{
+		{ID: "github/code-chat", Name: "Code Chat", Description: "Chat with code model"},
+	}
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.URL.Path != "/catalog/models" {
+			t.Errorf("unexpected path: %s", r.URL.Path)
+		}
+		if r.Header.Get("Authorization") != "Bearer test-token" {
+			t.Errorf("missing or wrong Authorization header")
+		}
+		w.Header().Set("Content-Type", "application/json")
+		json.NewEncoder(w).Encode(mockModels)
+	}))
+	defer ts.Close()
+
+	c := newTestClient(ts)
+	ctx := context.Background()
+
+	modelsList, err := c.ListModels(ctx)
+	if err != nil {
+		t.Fatalf("ListModels failed: %v", err)
+	}
+
+	if len(modelsList) != 1 {
+		t.Fatalf("expected 1 model, got %d", len(modelsList))
+	}
+	if modelsList[0].ID != "github/code-chat" {
+		t.Errorf("unexpected model ID: %s", modelsList[0].ID)
+	}
+}
+
+func TestChatCompletion(t *testing.T) {
+	mockResponse := models.ChatResponse{
+		ID: "chat-1",
+		Choices: []models.Choice{
+			{Message: models.Message{Role: "assistant", Content: "Hello!"}},
+		},
+	}
+
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.URL.Path != "/inference/chat/completions" {
+			t.Errorf("unexpected path: %s", r.URL.Path)
+		}
+		w.Header().Set("Content-Type", "application/json")
+		json.NewEncoder(w).Encode(mockResponse)
+	}))
+	defer ts.Close()
+
+	c := newTestClient(ts)
+	ctx := context.Background()
+
+	req := models.ChatRequest{
+		Model: "github/code-chat",
+		Messages: []models.Message{
+			{Role: "user", Content: "Hello"},
+		},
+	}
+
+	resp, err := c.ChatCompletion(ctx, req)
+	if err != nil {
+		t.Fatalf("ChatCompletion failed: %v", err)
+	}
+
+	if resp.ID != "chat-1" {
+		t.Errorf("unexpected response ID: %s", resp.ID)
+	}
+	if len(resp.Choices) != 1 {
+		t.Errorf("expected 1 choice, got %d", len(resp.Choices))
+	}
+	if resp.Choices[0].Message.Content != "Hello!" {
+		t.Errorf("unexpected response content: %s", resp.Choices[0].Message.Content)
+	}
+}