bosa-server-plugins-binary 0.6.0

No project description provided

BOSA GitHub Server Plugins

A collection of Plugin Routes for interacting with GitHub's API to manage repositories, metrics, issues, and projects. Implements BOSA Core as the Plugin Base.

Features

• GitHub API integration for various entities
• Plugin architecture for modularity and extensibility

Installation

Prerequisites

• Python 3.11+ - Install here
• Pip (if using Pip) - Install here
• Poetry 1.8.1+ (if using Poetry) - Install here
• Git (if using Git) - Install here
• For git installation:
  • Access to the GDP Labs SDK github repository

1. Installation from Pypi

Choose one of the following methods to install the package:

Using pip

pip install bosa-server-plugins-binary

Using Poetry

poetry add bosa-server-plugins-binary

2. Development Installation (Git)

For development purposes, you can install directly from the Git repository:

poetry add "git+ssh://[e-mail]/GDP-ADMIN/bosa-sdk.git#subdirectory=python/bosa-server-plugins"

Plugins

Github

Herein you'll find the actions provided by the github plugin.

Metrics

• get_all_contributor_commit_activity
• get_the_last_year_of_commit_activity
• get_weekly_commit_count

Repositories

• list_commits
• list_collaborators
• list_releases
• list_contributors
• list_languages

Pull Requests

• list_pull_requests

Issues

• create_issue
• list_issues
• list_issues_comments

Projects

• list_project_items

Important Implementation Notes

POST Requests Only All endpoints are configured as POST requests to:

• Enable structured request bodies
• Maintain consistency across the API surface
• Allow complex query parameters via request models

Authentication is handled through the X-Api-Key header in requests, which is provided by the main BOSA Router implementation.

Example request:

curl -X POST http://localhost:8000/get_weekly_commit_count \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: your-api-key" \
  -d '{"owner": "your-org", "repo": "your-repo"}'

References

Product Requirements Documents(PRD):

• BOSA Connector - Product Document

Architecture Documents:

• BOSA Connector - Architecture Document

Design Documents:

• BOSA Connector - Design Document

Implementation Documents:

• BOSA Connector - Implementation Document