Skip to main content

This is a toolkit library for the LLM application using the multiple openapi specifications

Project description

zmp-openapi-toolkit

Platform Badge Component Badge CI Badge License Badge PyPI - Version PyPI - Implementation PyPI - Python Version PyPI - Wheel PyPI - Download

Introduction

This is a toolkit library for the LLM application using the multiple openapi specifications

Key Features

  • Support the OpenAPI request wrapper
  • OpenAPI parameters and request type validation
  • Convenient authentication management

Installation

Install using pip:

pip install zmp-openapi-toolkit

Install using poetry:

poetry add zmp-openapi-toolkit

Usage

Basic example:

import logging
import logging.config
from typing import List

from zmp_openapi_toolkit import (
    MixedAPISpecConfig,
    ZmpAPIWrapper,
    ZmpTool,
    ZmpToolkit,
)

logging.getLogger("zmp_openapi_toolkit.openapi.zmpapi_models").setLevel(logging.INFO)
logging.getLogger("zmp_openapi_toolkit.toolkits.toolkit").setLevel(logging.INFO)

if __name__ == "__main__":
    mixed_api_spec_config = MixedAPISpecConfig.from_mixed_spec_file(
        file_path="samples/openapi/zmp_mixed_api_spec.json"
    )

    zmp_api_wrapper = ZmpAPIWrapper(
        "https://your.server.com", mixed_api_spec_config=mixed_api_spec_config
    )
    toolkit = ZmpToolkit.from_zmp_api_wrapper(zmp_api_wrapper=zmp_api_wrapper)
    tools: List[ZmpTool] = toolkit.get_tools()

For more detailed usage instructions, please refer to our documentation.

Development Setup

  1. Clone the repository
git clone https://github.com/yourusername/zmp-openapi-toolkit.git
cd zmp-openapi-toolkit
  1. Create and activate virtual environment
python -m venv .venv
source .venv/bin/activate  # Windows: venv\Scripts\activate
  1. Install development dependencies
poetry install

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

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

zmp_openapi_toolkit-0.2.0.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

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

zmp_openapi_toolkit-0.2.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file zmp_openapi_toolkit-0.2.0.tar.gz.

File metadata

  • Download URL: zmp_openapi_toolkit-0.2.0.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.11.10 Darwin/24.3.0

File hashes

Hashes for zmp_openapi_toolkit-0.2.0.tar.gz
Algorithm Hash digest
SHA256 e916fbb837027790ce2a16180b6a5d985aa52b827acab11abb333d8f64b673d0
MD5 0897805aa75a6b31085b48e89fa1fd74
BLAKE2b-256 6d2afe51867b84fa538d18ae953b54bdc8033035bb32d5406b5a4f9f013786cb

See more details on using hashes here.

File details

Details for the file zmp_openapi_toolkit-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for zmp_openapi_toolkit-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 37ead12da59a1b41b8a4ac152e36fe5a9f7c68508eaf40842c05f5f2a69097f8
MD5 6847042cf98b5e103909c2a3f01260af
BLAKE2b-256 6a7daea4a7c8e4063aa69b2574224d2823811215197d57bc32108da68d9b78e3

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