Skip to content

index.md

Latest commit

 

History

History
93 lines (74 loc) · 3.39 KB

index.md

File metadata and controls

93 lines (74 loc) · 3.39 KB

Development and Infrastructure

This page explains what to use depending on your goal, how the repositories fit together, and what is reserved to the internal team. It also clarifies the licensing status.

Who uses what

If you want to try or build with Summoner

  • Use examples Repo: summoner-agents. Run ready-made agents that show @receive and @send(multi=True) patterns. Typical flow:

    git clone https://github.com/Summoner-Network/summoner-agents
cd summoner-agents
source build_sdk.sh setup
source venv/bin/activate
python agents/agent_EchoAgent_0/agent.py

  • Assemble your own SDK from modules Repo: summoner-sdk. Edit build.txt, then:

    git clone https://github.com/Summoner-Network/summoner-sdk
cd summoner-sdk
source build_sdk.sh setup
source venv/bin/activate

  • Create a new module Repo: extension-template. Start a native package under tooling/, then integrate it via summoner-sdk.

  • Optional desktop UI Repo: summoner-desktop. A visual interface for running agents and servers.

If you want to contribute

  • Open issues in the relevant public repo. See "How to contribute" for scope and expectations.
  • Publish modules from the extension-template and reference them in summoner-sdk recipes.
  • For proposed changes to core behavior, open a design issue first. Direct code changes to core are internal.

Note

Environment expectations

  • macOS and Linux are supported. On Windows, use WSL2 or Git Bash in VS Code.

  • Python 3.9 or newer. Example agents are validated on 3.11.

  • Rust toolchain installed via rustup to build servers.

  • The setup installs summoner in editable mode. Example:

    from summoner.server import SummonerServer

Licensing and IP status

Unless a repository states otherwise, Summoner public repositories are licensed under the Apache License, Version 2.0. The controlling terms are the LICENSE file at the root of each repository. If a repository lacks a LICENSE, no license is granted — open an issue.

Important

What Apache-2.0 allows

  • Use, modify, and redistribute the code, including commercially.
  • Patent license from contributors.

Your obligations

  • Keep the repo LICENSE and any NOTICE files with your distributions.
  • State significant changes you make.
  • Respect third-party dependency licenses.

Scope

  • Trademarks, logos, and brand names are not licensed.
  • Security disclosure policies and secrets handling still apply.

Contributions

  • By contributing, you agree your changes are provided under Apache-2.0.
  • See CONTRIBUTING.md for DCO sign-off or CLA requirements.

What is reserved to the internal team

  • Direct code changes to summoner-core and official server implementations.
  • Protocol decisions, security-critical components, and release management.
  • Official modules published under the Summoner organization and their versioning.
  • Branding assets and the desktop application release pipeline.

External developers are encouraged to extend the platform through modules, open focused issues, and propose designs with clear scope and rationale.

« Previous: Developer & Contribution    |    Next: Github Repo Organization »