⭐ Integrates Claude Desktop with the web, Google and Atlassian workspaces.
Project description
⭐ Starbridge
[!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:
- Fast and easy to use project setup
- Consistent update of already scaffolded projects to benefit from new and improved features.
- 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 API is versioned, mounted at
/api/v1resp./api/v2 - While serving the webservice API go to http://127.0.0.1:8000/api/v1/hello-world to see the respons of the
hello-worldoperation. - Interactive documentation is provided at http://127.0.0.1:8000/api/docs
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:
- Various examples demonstrating usage:
- Simple Python script
- Streamlit web application deployed on Streamlit Community Cloud
- Jupyter and Marimo notebook
- Complete reference documentation on Read the Docs
- Transparent test coverage including unit and E2E tests (reported on Codecov)
- Matrix tested with multiple python versions to ensure compatibility (powered by Nox)
- Compliant with modern linting and formatting standards (powered by Ruff)
- Up-to-date dependencies (monitored by Renovate and GitHub Dependabot)
- A-grade code quality in security, maintainability, and reliability with low technical debt and codesmell (verified by SonarQube)
- Additional code security checks using GitHub CodeQL
- Security Policy
- License compliant with the Open Source Initiative (OSI)
- 1-liner for installation and execution of command line interface (CLI) via uv(x) or Docker
- Setup for developing inside a devcontainer included (supports VSCode and GitHub Codespaces)
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
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4b6a607adc2a40cc974634e32ea810d2bc926d4b01510987852c9f15e9a3fa4e
|
|
| MD5 |
9f37afbb384ae199c029826a476a5b22
|
|
| BLAKE2b-256 |
e7e7cfdd645ac95fff1b8624bcada559d857890130b0cde496fd47ce33cd3be2
|
File details
Details for the file starbridge-0.0.86-py3-none-any.whl.
File metadata
- Download URL: starbridge-0.0.86-py3-none-any.whl
- Upload date:
- Size: 70.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.5.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
96458b310901c95abae8bb67531ee1925a1c5c21c91bcf6dcef7dc92723abf6e
|
|
| MD5 |
de642c7ff6e0d30ea5f584eca5a831f8
|
|
| BLAKE2b-256 |
9755eb41d0317232aea593b781f61cbd0678e51ffef5de0a2c0aa379ee645172
|