swarmauri/swarmauri-sdk

AI 总结

• `swarmauri_core`: Core interfaces and constants
• `swarmauri_base`: Abstract base classes for extensibility
• `swarmauri_standard`: Standard implementations of common components
• `swarmauri`: Main namespace package that unifies all components
• `pkgs/community`: Community-maintained packages and integrations
• `pkgs/deprecated`: Retired packages that remain for historical reference

内容摘录

!Swarmauri Logo

<p align="center">
 <a href="https://pypi.org/project/swarmauri/">
 <img src="https://img.shields.io/pypi/dm/swarmauri" alt="PyPI - Downloads"/></a>
 <a href="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/swarmauri/">
 <img alt="Hits" src="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/swarmauri.svg"/></a>
 <a href="https://pypi.org/project/swarmauri/">
 <img src="https://img.shields.io/pypi/pyversions/swarmauri" alt="PyPI - Python Version"/></a>
 <a href="https://pypi.org/project/swarmauri/">
 <img src="https://img.shields.io/pypi/l/swarmauri" alt="PyPI - License"/></a>
 <a href="https://pypi.org/project/swarmauri/">
 <img src="https://img.shields.io/pypi/v/swarmauri?label=swarmauri&color=green" alt="PyPI - swarmauri"/></a>
</p>

---
Swarmauri SDK

The Swarmauri SDK provides a powerful, extensible framework for building AI-powered applications. This repository includes core interfaces, standard abstract base classes, and concrete reference implementations.
Installation Options

Swarmauri offers multiple installation options to suit different needs:
Option 1: Complete SDK Installation

For a full-featured experience with all standard components:
Option 2: Core Only
For a minimal installation with just the core interfaces:
Option 3: Standalone Packages

Install specific packages for targeted functionality:
Development Installation

For contributors or those wanting the latest features:
Using Swarmauri Components
Method 1: Use the namespace package (recommended)

The swarmauri package acts as a namespace microkernel. Importing swarmauri
registers a custom importer that resolves classes from installed first-party and
community plugins.
Method 2: Use the index to discover what is available

Use the plugin citizenship registry as an index of resource paths to concrete
module locations.
Method 3: Direct package imports

For explicit dependency control, import classes directly from their package.
Package Structure
The Swarmauri SDK is organized into several key packages:
swarmauri_core: Core interfaces and constants
swarmauri_base: Abstract base classes for extensibility
swarmauri_standard: Standard implementations of common components
swarmauri: Main namespace package that unifies all components
pkgs/community: Community-maintained packages and integrations
pkgs/deprecated: Retired packages that remain for historical reference

Individual components follow these naming conventions:
swarmauri_vectorstore_*: Vector database integrations
swarmauri_embedding_*: Embedding model implementations
swarmauri_tool_*: Task-specific tools
swarmauri_parser_*: Text parsing utilities
swarmauri_distance_*: Distance calculation methods
For Contributors
If you want to contribute to the Swarmauri SDK, please read our guidelines for contributing and style guide to get started.
Creating a New Plugin
Swarmauri uses Python's entry point system for plugin discovery. Here's how to register your component:
License
The Swarmauri SDK is licensed under the Apache License 2.0. See the LICENSE file for details.