Skip to main content

Load YAML-defined components directly from GitHub repositories.

Project description

Swarmauri Logo

PyPI - Downloads Hits PyPI - Python Version PyPI - License PyPI - swarmauri_tool_githubloader Discord

Swarmauri Tool GithubLoader

Load YAML-defined components directly from GitHub repositories.

Installation

pip install swarmauri_tool_githubloader

Usage

from swarmauri_tool_githubloader import GithubLoadedTool

# Load a tool from GitHub
tool = GithubLoadedTool(
    owner="myorg",
    repo="myrepo",
    path="tools/addition.yaml",
)

# Use like any other tool
result = tool(x=1, y=2)

Options

Customize how the loader fetches your component:

  • branch ? Branch to read from (defaults to "master").
  • commit_ref ? Specific commit SHA; overrides branch when provided.
  • token ? GitHub token for private repositories.
  • use_cache ? Set to False to reload the component on every call.

Advanced examples

Fetch from a branch and pin a commit:

tool = GithubLoadedTool(
    owner="myorg",
    repo="myrepo",
    path="tools/addition.yaml",
    branch="develop",
    commit_ref="0123456789abcdef",
)

Load from a private repository with caching disabled:

import os

tool = GithubLoadedTool(
    owner="myorg",
    repo="private-repo",
    path="tools/addition.yaml",
    token=os.environ["GITHUB_TOKEN"],
    use_cache=False,
)

Want to help?

If you want to contribute to swarmauri-sdk, read up on our guidelines for contributing that will help you get started.

Project details


Download files

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

Source Distribution

swarmauri_tool_githubloader-0.11.0.dev1.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

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

File details

Details for the file swarmauri_tool_githubloader-0.11.0.dev1.tar.gz.

File metadata

  • Download URL: swarmauri_tool_githubloader-0.11.0.dev1.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for swarmauri_tool_githubloader-0.11.0.dev1.tar.gz
Algorithm Hash digest
SHA256 1c32671715a5b03d47ade6b38d69f92090b12a075c06767edcc5c05cee2348c0
MD5 4c9c3fbf0ca0852fc73551a74719f8dd
BLAKE2b-256 912b33b178997dcca9f52a514720175e86cca5b01ae92f4a4012be74073c4029

See more details on using hashes here.

File details

Details for the file swarmauri_tool_githubloader-0.11.0.dev1-py3-none-any.whl.

File metadata

  • Download URL: swarmauri_tool_githubloader-0.11.0.dev1-py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for swarmauri_tool_githubloader-0.11.0.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 3dbdc27ca37457b7da2c2adf6914a5a274ef264e79f30302ca1370996fc6354f
MD5 05db4293dd5f4a1a2661a709727be158
BLAKE2b-256 b4edb3d865f9846795dd6a2c3097dcca509a5f2f144724e842a9f3bc8da62bc7

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