Metadata-Version: 2.4
Name: hubzoid
Version: 1.3.2
Summary: An open-source framework for production AI agents.
Author-email: HubZoid <hello@hubzoid.com>
Maintainer-email: HubZoid <hello@hubzoid.com>
License: 
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://github.com/hubzoid/hubzoid
Project-URL: Repository, https://github.com/hubzoid/hubzoid
Project-URL: Issues, https://github.com/hubzoid/hubzoid/issues
Project-URL: Changelog, https://github.com/hubzoid/hubzoid/releases
Keywords: agents,ai,llm,openai,anthropic,claude,openrouter,markdown,agents.md,mcp
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: openai-agents[litellm]<0.18,>=0.17.3
Requires-Dist: litellm<1.96,>=1.95.0
Requires-Dist: claude-agent-sdk<0.3,>=0.2.159
Requires-Dist: fastmcp<4,>=3.4.7
Requires-Dist: starlette<2,>=0.47
Requires-Dist: websockets<18,>=15
Requires-Dist: PyYAML<7,>=6.0.3
Requires-Dist: python-dotenv<2,>=1.2
Requires-Dist: composio<0.16,>=0.15
Requires-Dist: opentelemetry-proto<2,>=1.44
Requires-Dist: typer<1,>=0.27
Requires-Dist: jinja2<4,>=3.1.6
Requires-Dist: slack-bolt<2,>=1.30
Requires-Dist: casbin<2,>=1.43
Requires-Dist: dbos==3.1.0
Requires-Dist: croniter<7,>=6.2
Requires-Dist: pwdlib[argon2,bcrypt]<0.4,>=0.3.1
Requires-Dist: python-multipart<0.1,>=0.0.32
Requires-Dist: openai<2.30,>=2.29.0
Requires-Dist: mcp<1.28,>=1.27.2
Requires-Dist: tiktoken<0.14,>=0.13
Requires-Dist: fastapi<0.137,>=0.136.3
Requires-Dist: uvicorn[standard]<0.52,>=0.51
Requires-Dist: httpx<0.29,>=0.28.1
Requires-Dist: pydantic<2.14,>=2.13.4
Requires-Dist: cryptography<49,>=48
Requires-Dist: rich<14,>=13.9
Requires-Dist: pypdf<6.8,>=6.7.5
Requires-Dist: Pillow<12.3,>=12.2
Requires-Dist: SQLAlchemy<2.1,>=2.0.50
Requires-Dist: alembic<1.19,>=1.18.4
Requires-Dist: boto3<1.43,>=1.42.62
Requires-Dist: authlib<1.8,>=1.7.2
Requires-Dist: itsdangerous<2.3,>=2.2
Provides-Extra: postgres
Requires-Dist: psycopg[binary]<4,>=3.3; extra == "postgres"
Provides-Extra: openwebui
Requires-Dist: open-webui==0.11.4; extra == "openwebui"
Provides-Extra: dev
Requires-Dist: pytest>=8; extra == "dev"
Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
Requires-Dist: pytest-split>=0.10; extra == "dev"
Requires-Dist: pytest-timeout>=2.3; extra == "dev"
Requires-Dist: setuptools>=68; extra == "dev"
Requires-Dist: build>=1.2; extra == "dev"
Requires-Dist: twine>=5.0; extra == "dev"
Requires-Dist: reportlab>=4.0; extra == "dev"
Dynamic: license-file

<p align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/hubzoid/hubzoid/72ac7bf1610c8a335b9b3ac3b536de8fdb6770f1/assets/mark-dark.svg">
    <img alt="Hubzoid" src="https://raw.githubusercontent.com/hubzoid/hubzoid/72ac7bf1610c8a335b9b3ac3b536de8fdb6770f1/assets/mark-light.svg" width="240">
  </picture>
</p>

<h3 align="center">One brain for your internal agents.</h3>
<p align="center">Your knowledge. Your way of working. Useful across your assistants and your team.</p>
<p align="center">
  <a href="https://hubzoid.com/docs">Documentation</a> ·
  <a href="https://github.com/hubzoid/hubzoid/blob/main/docs/quickstart.md">Quickstart</a> ·
  <a href="https://hubzoid.com">Website</a> ·
  <a href="https://github.com/hubzoid/hubzoid/blob/main/CONTRIBUTING.md">Contribute</a>
</p>
<p align="center">
  <a href="https://pypi.org/project/hubzoid/"><img src="https://img.shields.io/pypi/v/hubzoid?color=B5471F" alt="PyPI version"></a>
  <a href="https://github.com/hubzoid/hubzoid/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-0B0B0C" alt="Apache License 2.0"></a>
</p>

**Hubzoid turns a folder of your knowledge, rules and tools into an agent you can
use yourself and share with your team.** Ask it questions in chat, run repeatable
workflows, or connect your own assistant through MCP.

Start with one useful job: a stock check, a policy answer, or a weekly report.
Keep the context and rules in files you can read, edit and version. Add teammates
with access to the agents and capabilities they need.

<p align="center">
  <img alt="Your agent folder becomes a shared Hub for chat, workflows and your assistant through MCP." src="https://raw.githubusercontent.com/hubzoid/hubzoid/72ac7bf1610c8a335b9b3ac3b536de8fdb6770f1/assets/shared-hub-light.svg" width="680">
</p>

## Get your first useful result

Use Claude Code or Codex with the setup prompt below, or run these commands
yourself.

Use **Python 3.11 or 3.12** in a virtual environment:

```bash
python3.12 -m venv .venv
source .venv/bin/activate
pip install hubzoid
hubzoid init my-hub
hubzoid run my-hub
```

The web app opens at **http://127.0.0.1:3080**. Ask:

> What should we reorder, and what could run out first?

The starter is an operations assistant for a **fictional home-goods shop**. It
uses a stock export and saved policies to explain what needs attention. You can
inspect the numbers and rules in `my-hub/`.

`init` detects a signed-in Claude Code or Codex CLI. Otherwise it offers to save
a model API key in the Hub's private `.env`. Chat needs model authentication;
provider charges or subscription limits apply. [Choose a runtime →](https://github.com/hubzoid/hubzoid/blob/main/docs/providers.md)

<details>
<summary>Prefer to set up with Claude Code or Codex?</summary>

Paste this into your coding assistant:

```text
Help me set up a local Hubzoid agent using the current quickstart:
https://github.com/hubzoid/hubzoid/blob/main/docs/quickstart.md

Use a new folder and a Python 3.11 or 3.12 virtual environment.
Help me choose an available runtime without pasting secrets into chat.
Run the operations sample and show me one result from its stock data.
Then help me adapt it to one task using material I choose.
Show me proposed file changes before replacing sample content.
```

Your coding assistant helps author the Hub. Its setup conversation is not
shared Hub knowledge. Authoring, runtime selection and MCP access are separate.

</details>

Local mode is private to your machine. Turn on sign-in before sharing access.
For Windows, uv, troubleshooting and source installation, see the
[quickstart](https://github.com/hubzoid/hubzoid/blob/main/docs/quickstart.md).

**Python 3.12 workflows need SQLite 3.42+ or PostgreSQL.** `hubzoid doctor my-hub`
checks the environment. This checkout targets **1.3.2**; until it is published,
`pip install hubzoid` installs the earlier release. Use the
[source-install steps](https://github.com/hubzoid/hubzoid/blob/main/docs/quickstart.md#run-this-checkout)
to try this revision. 1.3.0 was skipped.

## Make it work your way

Try a correction you can verify:

1. Ask the sample: **“A customer opened a blender 40 days ago and wants to
   return it. What can we offer?”** Its saved change-of-mind policy is 30 days.
2. Ask Claude Code or Codex to change the **change-of-mind** window to 45 days
   in `my-hub/knowledge/returns-policy.md`, keep the faulty-item rules unchanged,
   and show you the diff. Or edit the file yourself.
3. Restart the Hub and ask again. The answer should apply the saved 45-day
   window and the policy's other conditions.

Then replace the fictional policies and stock export with your own material.
Only explicit Hub content is shared; a correction in chat alone does not become
shared knowledge or automatic memory.
[Learn to author a Hub →](https://github.com/hubzoid/hubzoid/blob/main/docs/authoring-a-hub.md)

## One Hub, three ways to use it

| You want to… | Use… |
|---|---|
| Ask about your work and get a useful answer | **Chat**, with your Hub's knowledge and permitted tools |
| Repeat a report or check, with saved inputs and results | **Workflows**, on demand or on a schedule |
| Bring the same capabilities into your own assistant | **MCP**, with your own access |

In **1.3.1**, offered reports can run from chat and have personal schedules.
**My workspace → Schedules & reports** shows available reports, recent results
and your schedules. Edit inputs and timing, pause or stop. Schedules need the
Hub running; email notices are off by default.
[Reports, permissions and sharing →](https://github.com/hubzoid/hubzoid/blob/main/docs/reports-and-email.md)

For Claude Code, use the connection command printed by `hubzoid run`, then open
`/mcp` in Claude Code and approve the connection. Other clients have their own
setup. [Connect your assistant →](https://github.com/hubzoid/hubzoid/blob/main/docs/mcp-server.md)

## Pick a starting point

| Sample | What you can try | Create it |
|---|---|---|
| **Operations** | Stock decisions, supplier delays and customer returns from sample data and policies | `hubzoid init my-hub` |
| **Watchtower** | A personal service report, an explicit rule correction and repeat runs; also a model-assisted incident check | `hubzoid init my-watchtower --template watchtower` |
| **Guided tour** | Explore Hub tools, knowledge and skills | `hubzoid init my-tour --template demo` |
| **GitZoid** | Review fictional pull requests against saved rules, then connect your own repos | `hubzoid init my-gitzoid --template gitzoid` |

Each sample includes instructions. Watchtower's
[Service snapshot walkthrough](https://github.com/hubzoid/hubzoid/blob/main/hubzoid/templates/watchtower/README.md#run-your-own-report-from-chat-131)
uses a model-free report; chat still uses your configured runtime.
GitZoid starts in preview mode with fictional data; reviews still use your
configured model. Its [setup guide](https://github.com/hubzoid/hubzoid/blob/main/hubzoid/templates/gitzoid/README.md)
covers GitHub access, existing PRs, publishing and costs.
For a small starting folder, use `--template minimal`.

## Share with your team

Turn on sign-in and set the public address in `my-hub/.env`, then create your
first administrator:

```dotenv
HUBZOID_AUTH=true
HUBZOID_PUBLIC_URL=https://hub.example.com
```

```bash
hubzoid admin create you@example.com my-hub --owner
```

Open the one-time sign-in link, set a password, and add teammates through
**Admin Console → People**. Grant access to the agents and capabilities they
need. Shared knowledge does not mean shared credentials or access to another
person's private results.

For a public deployment, configure HTTPS and persistent storage, then restart.
[Team setup](https://github.com/hubzoid/hubzoid/blob/main/docs/ADMINISTRATION.md) ·
[Deployment](https://github.com/hubzoid/hubzoid/blob/main/docs/DEPLOYING.md) ·
[Backup and restore](https://github.com/hubzoid/hubzoid/blob/main/docs/BACKUP.md)

**Optional Claude failover (1.3.2):** add up to two backup credentials to keep
answering when a Claude credential reaches a confirmed usage limit or its login
is rejected. Switching keeps the same model and permissions and never replays
work that has started. Existing single-credential setups are unchanged.
[Configuration, token replacement and limits →](docs/DEPLOYING.md#claude-credential-failover)

## Choose your interface

| Interface | Install and select |
|---|---|
| **Hubzoid web app — default** | `pip install hubzoid` includes chat and Console. No separate UI package or Node installation is needed. |
| **Open WebUI — optional supported interface** | `pip install 'hubzoid[openwebui]'`, then set `HUBZOID_UI=openwebui` in the Hub's `.env`. It adds a larger dependency set. |

Both interfaces are permanently supported, with equal support and release-testing
requirements. Native chat is the default; neither interface has a planned removal.
See the [release validation policy](docs/RELEASING.md#chat-interface-validation)
for required checks and current automation coverage.

The default app is built with assistant-ui and bundled with Hubzoid. When
upgrading an existing deployment, read the [upgrade guide](https://github.com/hubzoid/hubzoid/blob/main/docs/UPGRADING.md)
first, especially if moving from Open WebUI.

## Go further

| Next step | Guide |
|---|---|
| Add knowledge, skills, tools or specialist agents | [Hub authoring](https://github.com/hubzoid/hubzoid/blob/main/docs/authoring-a-hub.md) |
| Connect business systems | [MCP connectors](https://github.com/hubzoid/hubzoid/blob/main/docs/mcp.md) |
| Write repeatable work | [Python workflows](https://github.com/hubzoid/hubzoid/blob/main/docs/workflows.md), [Markdown tasks](https://github.com/hubzoid/hubzoid/blob/main/docs/schedule.md) |
| Check answer quality and inspect runs | [Evals](https://github.com/hubzoid/hubzoid/blob/main/docs/evals.md), [observability](https://github.com/hubzoid/hubzoid/blob/main/docs/OBSERVABILITY.md) |
| Use Slack or other channels | [Slack](https://github.com/hubzoid/hubzoid/blob/main/docs/slack.md), [other channels](https://github.com/hubzoid/hubzoid/blob/main/docs/inbound-surfaces.md) |

[All guides](https://github.com/hubzoid/hubzoid/blob/main/docs/README.md) ·
[Website documentation](https://hubzoid.com/docs) ·
[Release notes](https://github.com/hubzoid/hubzoid/blob/main/CHANGELOG.md)

Hubzoid is **Apache-2.0**, including team controls. Dependencies and brand assets
retain their own terms. [Licensing](https://github.com/hubzoid/hubzoid/blob/main/LICENSING.md).
To contribute, start with the [contributing guide](https://github.com/hubzoid/hubzoid/blob/main/CONTRIBUTING.md).
Need help with your company's agent? [Build with us](https://hubzoid.com/enterprise)
uses the same open-source product.
