Metadata-Version: 2.4
Name: toolregistry-hub
Version: 0.8.2
Summary: ToolRegistry Hub: Ready-to-Use Tool Collection for LLM Agents — web search, file ops, code execution, and more
Author-email: Oaklight <oaklight@gmx.com>
License: MIT
Project-URL: Documentation, https://toolregistry.readthedocs.io
Project-URL: Repository, https://github.com/Oaklight/toolregistry-hub
Project-URL: Issues, https://github.com/Oaklight/toolregistry-hub/issues
Keywords: llm,tool-calling,function-calling,ai-agents,mcp,mcp-tools,openapi,agentic-ai,web-search,file-operations
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: ty>=0.0.21; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: complexipy>=5.2.0; extra == "dev"
Requires-Dist: python-dotenv>=1.0.1; extra == "dev"
Requires-Dist: build>=1.2.2.post1; extra == "dev"
Requires-Dist: twine>=6.1.0; extra == "dev"
Requires-Dist: pytest>=7.0.0; extra == "dev"
Provides-Extra: reader
Requires-Dist: pypdf>=4.0.0; extra == "reader"
Provides-Extra: reader-image
Requires-Dist: Pillow>=10.0.0; extra == "reader-image"
Provides-Extra: reader-plus
Requires-Dist: pdfplumber>=0.10.0; extra == "reader-plus"
Provides-Extra: server-core
Requires-Dist: toolregistry-server>=0.3.2; extra == "server-core"
Provides-Extra: server-openapi
Requires-Dist: toolregistry-hub[server_core]; extra == "server-openapi"
Requires-Dist: toolregistry-server[openapi]>=0.3.2; extra == "server-openapi"
Provides-Extra: server-mcp
Requires-Dist: toolregistry-hub[server_core]; extra == "server-mcp"
Requires-Dist: toolregistry-server[mcp]>=0.3.2; extra == "server-mcp"
Provides-Extra: server
Requires-Dist: toolregistry-hub[server_openapi]; extra == "server"
Requires-Dist: toolregistry-hub[server_mcp]; extra == "server"
Dynamic: license-file

# ToolRegistry Hub Documentation

[![PyPI version](https://img.shields.io/pypi/v/toolregistry-hub?color=green)](https://pypi.org/project/toolregistry-hub/)
[![Docker Image](https://img.shields.io/docker/v/oaklight/toolregistry-hub-server?label=docker&color=green)](https://hub.docker.com/r/oaklight/toolregistry-hub-server)
[![CI](https://github.com/Oaklight/toolregistry-hub/actions/workflows/ci.yml/badge.svg)](https://github.com/Oaklight/toolregistry-hub/actions/workflows/ci.yml)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Oaklight/toolregistry-hub)

[中文版](readme_zh.md) | English version

Welcome to the ToolRegistry Hub documentation! This document provides detailed descriptions of all tools in the project.

## Ecosystem

| Package | Description | PyPI | Docs |
|---------|-------------|------|------|
| [**toolregistry**](https://github.com/Oaklight/ToolRegistry) | Core library — tool registration, schema generation, execution | [![PyPI](https://img.shields.io/pypi/v/toolregistry?color=green)](https://pypi.org/project/toolregistry/) | [Docs](https://toolregistry.readthedocs.io/) |
| [**toolregistry-server**](https://github.com/Oaklight/toolregistry-server) | Server adapters — expose tools via OpenAPI & MCP | [![PyPI](https://img.shields.io/pypi/v/toolregistry-server?color=green)](https://pypi.org/project/toolregistry-server/) | [Docs](https://toolregistry-server.readthedocs.io/) |
| [**toolregistry-hub**](https://github.com/Oaklight/toolregistry-hub) | Ready-to-use tools — calculator, web search, file ops, etc. | [![PyPI](https://img.shields.io/pypi/v/toolregistry-hub?color=green)](https://pypi.org/project/toolregistry-hub/) | [Docs](https://toolregistry-hub.readthedocs.io/) |

## 📚 Documentation

For detailed documentation, please visit our ReadTheDocs pages:

- **English Documentation**: [https://toolregistry-hub.readthedocs.io/en/latest/](https://toolregistry-hub.readthedocs.io/en/latest/)
- **中文文档**: [https://toolregistry-hub.readthedocs.io/zh-cn/latest/](https://toolregistry-hub.readthedocs.io/zh-cn/latest/)

## Tools Overview

ToolRegistry Hub is a Python library that provides various utility tools designed to support common tasks. Here are the main tool categories:

- Calculator Tools - Provides various mathematical calculation functions
- Date Time Tools - Handles date, time, and timezone conversions
- File Operations Tools - Provides file content manipulation functions
- File System Tools - Provides file system operation functions
- Web Search Tools - Provides web search functionality
- Unit Converter Tools - Provides conversions between various units
- Other Tools - Other utility tools
- Server Mode - REST API and MCP server
- Docker Deployment - Docker containerization deployment

For detailed information about each tool category, please refer to the [online documentation](https://toolregistry-hub.readthedocs.io/en/latest/).

## Quick Start

To use ToolRegistry Hub, first install the library:

```bash
pip install toolregistry-hub
```

Then, you can import and use the required tools:

```python
from toolregistry_hub import Calculator, DateTime, FileOps

# Use calculator
result = Calculator.evaluate("2 + 2 * 3")
print(result)  # Output: 8

# Get current time
current_time = DateTime.now()
print(current_time)
```

## Documentation Structure

This documentation is organized by tool categories, with each tool category having its own page that details all tools, methods, and usage examples under that category.

## Contributing

If you want to contribute to ToolRegistry Hub, please refer to the [GitHub repository](https://github.com/Oaklight/toolregistry-hub).
