Skip to main content

⭐ Integrates Claude Desktop with the web, Google and Atlassian workspaces.

Project description

⭐ Starbridge

License PyPI - Python Version CI Read the Docs CodeQL Dependabot Quality Gate Security Maintainability Technical Debt Code Smells Coverage Ruff MyPy GitHub - Version GitHub - Commits PyPI - Version PyPI - Status Docker - Version Docker - Size Copier Open in Dev Containers Open in GitHub Codespaces

[!TIP] 📚 Online documentation - 📖 PDF Manual

[!NOTE] 🧠 This project was scaffolded using the template oe-python-template with copier.


Integrates Claude Desktop with the web, Google and Atlassian workspaces.

Use Cases:

  1. Fast and easy to use project setup
  2. Consistent update of already scaffolded projects to benefit from new and improved features.
  3. Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline

Scaffolding

Step 1: Install uv package manager and copier

if [[ "$OSTYPE" == "darwin"* ]]; then                 # Install dependencies for macOS X
  if ! command -v brew &> /dev/null; then             ## Install Homebrew if not present
    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  fi
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then            # Install dependencies for Linux
  sudo apt-get update -y && sudo apt-get install curl -y # Install curl
fi
if ! command -v uvx &> /dev/null; then                # Install uv package manager if not present
  curl -LsSf https://astral.sh/uv/install.sh | sh
  source $HOME/.local/bin/env
fi
uv tool install copier                                # Install copier as global tool

Step 2: Now create an empty repository on GitHubm, clone to your local machine, and change into it's directory.

Step 3: Scaffold the project

copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .

Step 4: Setup the local environment

uv run nox -s setup_dev

Step 5: Perform initial commit and push

git add .
git commit -m "feat: Initial commit"
git push

Visit your GitHub repository and check the Actions tab. The CI workflow should fail at the SonarQube step, as this external service is not yet configured for our new repository.

Step 6: Follow the instructions to wire up external services such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.

Step 7: Release the first versions

./bump

Notes:

  • You can remove this section post having successfully scafolded your project.
  • The following sections refer to the dummy application and service provided by this template. Use them as inspiration and adapt them to your own project.

Overview

Adding Starbridge to your project as a dependency is easy.

uv add starbridge             # add dependency to your project

If you don't have uv installed follow these instructions. If you still prefer pip over the modern and fast package manager uv, you can install the library like this:

pip install starbridge        # add dependency to your project

Executing the command line interface (CLI) in an isolated Python environment is just as easy:

uvx starbridge hello-world     # prints "Hello, world! [..]"
uvx starbridge serve           # serves webservice API
uvx starbridge serve --port=4711 # serves webservice API on port 4711

Notes:

The CLI provides extensive help:

uvx starbridge --help                # all CLI commands
uvx starbridge hello-world --help    # help for specific command
uvx starbridge echo --help
uvx starbridge openapi --help
uvx starbridge serve --help

Operational Excellence

This project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:

Example Prompts

  • "Create a page about road cycling, focusing on Canyon bikes, in the personal confluence space of Helmut."

Setup

uvx starbridge install - that's all.

Prequisites:

  • You are running Mac OS X
  • You already have the uv package manager installed
  • You already have Claude Desktop for Mac OS X installed
  • You don't care for the imaging extra

If you need to first install homebrew and uv - and care for all extras:

if [[ "$OSTYPE" == "darwin"* ]]; then # Install dependencies for macOS X
  if ! command -v brew &> /dev/null; then # Install Homebrew if not present
    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  fi
  brew install cairo
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then # Install dependencies for Linux
  sudo apt-get update -y && sudo apt-get install curl libcairo2 -y
fi
if ! command -v uvx &> /dev/null; then # Install uv package manager if not present
  curl -LsSf https://astral.sh/uv/install.sh | sh
  source $HOME/.local/bin/env
fi
uvx --with "starbridge[imaging]" starbridge install # Install starbridge, including configuration and injection into Claude Desktop App

Starbridge can be run within Docker.

MCP Server

Starbridge implements the MCP Server interface, with Claude acting as an MCP client.

Resources

[TODO: Document resources exposed to Claude Desktop]

Prompts

[TODO: Document prompts exposed to Claude Desktop]

Tools

[TODO: Document tools exposed to Claude Desktop]

CLI

[TODO: Document CLI commands]

Further Reading

  • The Docker manual explains how to run Starbridge within Docker.
  • Check out the reference with detailed documentation of public classes and functions.
  • Our release notes provide a complete log of recent improvements and changes.
  • In case you want to help us improve Starbridge: The contribution guidelines explain how to setup your development environment and create pull requests.

Additional Resources

Star History

Star History Chart

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 Distribution

starbridge-0.0.86.tar.gz (13.8 MB view details)

Uploaded Source

Built Distribution

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

starbridge-0.0.86-py3-none-any.whl (70.4 kB view details)

Uploaded Python 3

File details

Details for the file starbridge-0.0.86.tar.gz.

File metadata

  • Download URL: starbridge-0.0.86.tar.gz
  • Upload date:
  • Size: 13.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.9

File hashes

Hashes for starbridge-0.0.86.tar.gz
Algorithm Hash digest
SHA256 4b6a607adc2a40cc974634e32ea810d2bc926d4b01510987852c9f15e9a3fa4e
MD5 9f37afbb384ae199c029826a476a5b22
BLAKE2b-256 e7e7cfdd645ac95fff1b8624bcada559d857890130b0cde496fd47ce33cd3be2

See more details on using hashes here.

File details

Details for the file starbridge-0.0.86-py3-none-any.whl.

File metadata

File hashes

Hashes for starbridge-0.0.86-py3-none-any.whl
Algorithm Hash digest
SHA256 96458b310901c95abae8bb67531ee1925a1c5c21c91bcf6dcef7dc92723abf6e
MD5 de642c7ff6e0d30ea5f584eca5a831f8
BLAKE2b-256 9755eb41d0317232aea593b781f61cbd0678e51ffef5de0a2c0aa379ee645172

See more details on using hashes here.

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