Skip to main content

BOSA Server Plugins

Project description

BOSA Server Plugins

A comprehensive collection of Plugin Routes for interacting with GitHub, Google services, Twitter, and other third-party APIs. Built on the BOSA Core plugin architecture.

Features

  • Multi-Platform Integration: GitHub, Google Drive, Google Mail, Google Docs, Twitter
  • OAuth Authentication: Secure authentication flows for all platforms
  • Plugin Architecture: Modular design for easy extension
  • Caching & Background Processing: Redis-based caching and async task processing

Installation

Prerequisites

Install from PyPI

# Using pip
pip install bosa-server-plugins-binary

# Using Poetry
poetry add bosa-server-plugins-binary

Development Installation

poetry add "git+ssh://git@github.com/GDP-ADMIN/bosa-sdk.git#subdirectory=python/bosa-server-plugins"

Configuration

Set the following environment variables:

# GitHub
GITHUB_CLIENT_ID=your-github-client-id
GITHUB_CLIENT_SECRET=your-github-client-secret
GITHUB_API_KEY=your-github-api-key

# Google Services
GOOGLE_CLIENT_ID=your-google-client-id
GOOGLE_CLIENT_SECRET=your-google-client-secret

# Twitter
TWITTER_BEARER_TOKEN=your-twitter-bearer-token
TWITTER_API_KEY=your-twitter-api-key
TWITTER_API_SECRET=your-twitter-api-secret

# BOSA Core
BOSA_API_URL=https://your-bosa-api-url
REDIS_URL=redis://localhost:6379
DATABASE_URL=postgresql://username:password@localhost:5432/dbname

Available Plugins

GitHub Plugin

Metrics: get_all_contributor_commit_activity, get_the_last_year_of_commit_activity, get_weekly_commit_count, get_user_contribution_statistics

Repositories: list_commits, search_commits, list_collaborators, list_releases, list_contributors, list_languages, search_contributions

Pull Requests: list_pull_requests, search_pull_requests, get_pull

Issues: create_issue, get_issue, list_issues, list_issues_comments, search_issues

Projects: list_project_items, list_projects

Google Drive Plugin

Files: search_files, get_file, create_file, create_folder, update_file, update_folder, copy_file, delete_file, summarize_folder_files_by_type, summarize_total_files_by_type, list_recent_files_from_yesterday

Permissions: create_permission, list_permissions, get_permission, update_permission, delete_permission

Download: download_file

Google Mail Plugin

Emails: send_email, list_emails, get_email_details, modify_email, delete_email, trash_email, untrash_email

Drafts: create_draft, list_drafts, send_draft, get_draft, modify_draft

Threads: list_threads, thread_details, modify_thread

Labels: list_labels, total_email_perlabel, get_label_details, create_labels, modify_labels, delete_labels

Attachments: get_attachment

Auto Reply: get_auto_reply, set_auto_reply

Google Docs Plugin

Documents: get_document, list_documents, create_document, update_document, copy_content, update_document_markdown

Comments: list_comments, summarize_comments

Twitter Plugin

Tweets: tweet_search, get_tweets, get_thread

Users: get-users

Google Plugin (General)

User: userinfo

API Usage

All endpoints use POST requests with JSON payloads and require authentication:

curl -X POST http://localhost:8000/endpoint_name \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: your-api-key" \
  -H "Authorization: Bearer your-token" \
  -d '{"param1": "value1", "param2": "value2"}'

Example: GitHub - List Commits

curl -X POST http://localhost:8000/list_commits \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: your-api-key" \
  -H "Authorization: Bearer your-token" \
  -d '{
    "owner": "GDP-ADMIN",
    "repo": "bosa-sdk",
    "per_page": 10
  }'

Example: Google Drive - Search Files

curl -X POST http://localhost:8000/search_files \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: your-api-key" \
  -H "Authorization: Bearer your-token" \
  -d '{
    "query": "name contains \"project\"",
    "page_size": 10
  }'

OAuth Integration

The plugins support OAuth authentication:

  1. Call initialize_authorization method
  2. Redirect users to authorization URL
  3. Handle OAuth callback to store tokens
  4. Use stored tokens for API calls

Development

Adding New Plugins

  1. Create plugin directory under bosa_server_plugins/
  2. Implement plugin class extending ThirdPartyIntegrationPlugin
  3. Define routes and authentication schemes
  4. Add API endpoint implementations

Testing & Code Quality

# Run tests
pytest tests/

# Format and check code
black bosa_server_plugins/
ruff check bosa_server_plugins/
mypy bosa_server_plugins/

Support

References

Product Requirements Documents (PRD)

Architecture Documents

Design Documents

Implementation Documents

License

This project is licensed under the terms specified by GDP Labs.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

bosa_server_plugins_binary-0.10.1-cp312-cp312-win_amd64.whl (2.3 MB view details)

Uploaded CPython 3.12Windows x86-64

bosa_server_plugins_binary-0.10.1-cp312-cp312-manylinux_2_31_x86_64.whl (3.5 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.31+ x86-64

bosa_server_plugins_binary-0.10.1-cp312-cp312-macosx_13_0_x86_64.whl (2.9 MB view details)

Uploaded CPython 3.12macOS 13.0+ x86-64

bosa_server_plugins_binary-0.10.1-cp312-cp312-macosx_13_0_arm64.macosx_15_0_arm64.whl (2.7 MB view details)

Uploaded CPython 3.12macOS 13.0+ ARM64macOS 15.0+ ARM64

bosa_server_plugins_binary-0.10.1-cp311-cp311-win_amd64.whl (2.3 MB view details)

Uploaded CPython 3.11Windows x86-64

bosa_server_plugins_binary-0.10.1-cp311-cp311-manylinux_2_31_x86_64.whl (3.2 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.31+ x86-64

bosa_server_plugins_binary-0.10.1-cp311-cp311-macosx_13_0_x86_64.whl (2.8 MB view details)

Uploaded CPython 3.11macOS 13.0+ x86-64

bosa_server_plugins_binary-0.10.1-cp311-cp311-macosx_13_0_arm64.macosx_15_0_arm64.whl (2.6 MB view details)

Uploaded CPython 3.11macOS 13.0+ ARM64macOS 15.0+ ARM64

File details

Details for the file bosa_server_plugins_binary-0.10.1-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for bosa_server_plugins_binary-0.10.1-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 743424e6508612be657ee548dff597a766fca9ac488d1663eb4197c7aac1cda4
MD5 a2c31f537b88516b78b5bc2052450560
BLAKE2b-256 a19a0ac16c618cb27921a1aebbee7fd3f189bbbf68ad38f439f472cb3fab21a7

See more details on using hashes here.

Provenance

The following attestation bundles were made for bosa_server_plugins_binary-0.10.1-cp312-cp312-win_amd64.whl:

Publisher: build-binary.yml on GDP-ADMIN/bosa-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bosa_server_plugins_binary-0.10.1-cp312-cp312-manylinux_2_31_x86_64.whl.

File metadata

File hashes

Hashes for bosa_server_plugins_binary-0.10.1-cp312-cp312-manylinux_2_31_x86_64.whl
Algorithm Hash digest
SHA256 2148e73f074912091ff7ed206639019aa110383e5e24b73503b05d0968d7b037
MD5 7ac1dbb69c0e1ad23fc4c887a5774e2e
BLAKE2b-256 f8058053b4732acf34502b81714b09de76dffe1f8d595305d6881f7ae545270d

See more details on using hashes here.

File details

Details for the file bosa_server_plugins_binary-0.10.1-cp312-cp312-macosx_13_0_x86_64.whl.

File metadata

File hashes

Hashes for bosa_server_plugins_binary-0.10.1-cp312-cp312-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 4c5b3c490dec682b33f719ae7e7b1d05de76d8a3e0fa08a4d20503881149febe
MD5 91241afa41b0f64f7f2869ac7207edc7
BLAKE2b-256 bff2abdabf2ddfe8b9e6541ceaf38ac78f46a1ee26d0810d946e42f01f766d24

See more details on using hashes here.

Provenance

The following attestation bundles were made for bosa_server_plugins_binary-0.10.1-cp312-cp312-macosx_13_0_x86_64.whl:

Publisher: build-binary.yml on GDP-ADMIN/bosa-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bosa_server_plugins_binary-0.10.1-cp312-cp312-macosx_13_0_arm64.macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for bosa_server_plugins_binary-0.10.1-cp312-cp312-macosx_13_0_arm64.macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 ec4edf74588cfe4eb70c7dd585674656bc1a5c14d090d5324df019175d7795dc
MD5 d7bdeac5bb8fdcbfcf4a0e541cbd7715
BLAKE2b-256 1feb5a44128d0b9f7854cd3b02a95665c03f73a39804856191b809879713d755

See more details on using hashes here.

Provenance

The following attestation bundles were made for bosa_server_plugins_binary-0.10.1-cp312-cp312-macosx_13_0_arm64.macosx_15_0_arm64.whl:

Publisher: build-binary.yml on GDP-ADMIN/bosa-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bosa_server_plugins_binary-0.10.1-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for bosa_server_plugins_binary-0.10.1-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 dccef2be44a3624b8e17ab9ae5e375a1c3c2b75d1851f4d91724158468eaf047
MD5 0d0253257619879240226cdaff7b7877
BLAKE2b-256 797051312d4eac373ee146aca8d8e73595d74c0e609d461e2ddf42a177e8cb2a

See more details on using hashes here.

Provenance

The following attestation bundles were made for bosa_server_plugins_binary-0.10.1-cp311-cp311-win_amd64.whl:

Publisher: build-binary.yml on GDP-ADMIN/bosa-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bosa_server_plugins_binary-0.10.1-cp311-cp311-manylinux_2_31_x86_64.whl.

File metadata

File hashes

Hashes for bosa_server_plugins_binary-0.10.1-cp311-cp311-manylinux_2_31_x86_64.whl
Algorithm Hash digest
SHA256 0384809b47c4abf66421e318c6b25b1f22a3ecbf32e578cf0b1ac477f5e913c1
MD5 ab01d76a08500a557da81c4281c7555c
BLAKE2b-256 f7bbed930512f02158f47bbf72835ccf50105083139750141a4efe79d07dadde

See more details on using hashes here.

File details

Details for the file bosa_server_plugins_binary-0.10.1-cp311-cp311-macosx_13_0_x86_64.whl.

File metadata

File hashes

Hashes for bosa_server_plugins_binary-0.10.1-cp311-cp311-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 2d0c9f159474d4a401cf5001370e3081a5c9be10b4be7d55efc035c4c26b4ce6
MD5 1c0d831aecbaa2c1f8391cb1375f1adb
BLAKE2b-256 f6e6d5826b97c5faff7c6249dcc33b6ee12dc025c83b01963d37afc795d16375

See more details on using hashes here.

Provenance

The following attestation bundles were made for bosa_server_plugins_binary-0.10.1-cp311-cp311-macosx_13_0_x86_64.whl:

Publisher: build-binary.yml on GDP-ADMIN/bosa-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bosa_server_plugins_binary-0.10.1-cp311-cp311-macosx_13_0_arm64.macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for bosa_server_plugins_binary-0.10.1-cp311-cp311-macosx_13_0_arm64.macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 07ad91bda34fe5b4fa9d9a09bc6cfd4ee117b21e0327349a423667ab7d964c24
MD5 4413e2e50f26905908f00e1199685817
BLAKE2b-256 63d1c04164ab120de12a5706c36c2a8aa8a97955402b65b53eba22e942cfae41

See more details on using hashes here.

Provenance

The following attestation bundles were made for bosa_server_plugins_binary-0.10.1-cp311-cp311-macosx_13_0_arm64.macosx_15_0_arm64.whl:

Publisher: build-binary.yml on GDP-ADMIN/bosa-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page