zmp-openapi-helper 0.2.0

This is a openapi helper library for the ZMP AI Platform

zmp-openapi-helper

Introduction

This is a openapi helper library for the ZMP AI Platform

Key Features

• Support the OpenAPI Specification(>3.0.0)
• Generate the Arguments Schema for the LLM

Installation

Install using pip:

pip install zmp-openapi-helper

Install using poetry:

poetry add zmp-openapi-helper

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="runner/openapi/zmp_mixed_api_spec.json"
    )

    zmp_api_wrapper = ZmpAPIWrapper(
        "https://api.zmp.vn", mixed_api_spec_config=mixed_api_spec_config
    )

    operations = zmp_api_wrapper.get_operations()
    for operation in operations:
        print("-" * 100)
        print(operation.args_schema)
        for field_name, field_info in operation.args_schema.model_fields.items():
            print(
                f"\t{field_name}: {field_info.annotation}, {field_info.default}, {field_info.description}"
            )

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

Development Setup

1. Clone the repository

git clone https://github.com/yourusername/zmp-openapi-helper.git
cd zmp-openapi-helper

2. Create and activate virtual environment

python -m venv .venv
source .venv/bin/activate  # Windows: venv\Scripts\activate

3. 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

• Issue Tracker: https://github.com/cloudz-mp/zmp-openapi-helper/issues
• Email: [e-mail]