zmp-openapi-toolkit


Namezmp-openapi-toolkit JSON
Version 0.1.2 PyPI version JSON
download
home_pagehttps://github.com/cloudz-mp
SummaryThis is a toolkit library for the LLM application using the multiple openapi specifications
upload_time2025-03-11 02:02:27
maintainerKilsoo Kang
docs_urlNone
authorKilsoo Kang
requires_python<4.0,>=3.11
licenseMIT
keywords llm toolkit openapi
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # zmp-openapi-toolkit

![Platform Badge](https://img.shields.io/badge/platform-zmp-red)
![Component Badge](https://img.shields.io/badge/component-toolkit-red)
![CI Badge](https://img.shields.io/badge/ci-github_action-green)
![License Badge](https://img.shields.io/badge/license-MIT-green)
![PyPI - Version](https://img.shields.io/pypi/v/zmp-openapi-toolkit)
![PyPI - Implementation](https://img.shields.io/pypi/implementation/zmp-openapi-toolkit)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/zmp-openapi-toolkit)
![PyPI - Wheel](https://img.shields.io/pypi/wheel/zmp-openapi-toolkit)

## 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:

```bash
pip install zmp-openapi-toolkit
```

Install using poetry:
```bash
poetry add zmp-openapi-toolkit
```

## Usage

Basic example:

```python
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](link).

## Development Setup

1. Clone the repository
```bash
git clone https://github.com/yourusername/zmp-openapi-toolkit.git
cd zmp-openapi-toolkit
```

2. Create and activate virtual environment
```bash
python -m venv .venv
source .venv/bin/activate  # Windows: venv\Scripts\activate
```

3. Install development dependencies
```bash
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](LICENSE) file for details.

## Contact

- Issue Tracker: https://github.com/yourusername/zmp-openapi-toolkit/issues
- Email: kilsoo75@gmail.com



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/cloudz-mp",
    "name": "zmp-openapi-toolkit",
    "maintainer": "Kilsoo Kang",
    "docs_url": null,
    "requires_python": "<4.0,>=3.11",
    "maintainer_email": "kilsoo75@gmail.com",
    "keywords": "llm, toolkit, openapi",
    "author": "Kilsoo Kang",
    "author_email": "kilsoo75@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/29/99/bca7ac51ee9892384aae878522febd8822f94c895fb9e2bec410d633438e/zmp_openapi_toolkit-0.1.2.tar.gz",
    "platform": null,
    "description": "# zmp-openapi-toolkit\n\n![Platform Badge](https://img.shields.io/badge/platform-zmp-red)\n![Component Badge](https://img.shields.io/badge/component-toolkit-red)\n![CI Badge](https://img.shields.io/badge/ci-github_action-green)\n![License Badge](https://img.shields.io/badge/license-MIT-green)\n![PyPI - Version](https://img.shields.io/pypi/v/zmp-openapi-toolkit)\n![PyPI - Implementation](https://img.shields.io/pypi/implementation/zmp-openapi-toolkit)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/zmp-openapi-toolkit)\n![PyPI - Wheel](https://img.shields.io/pypi/wheel/zmp-openapi-toolkit)\n\n## Introduction\n\nThis is a toolkit library for the LLM application using the multiple openapi specifications\n\n## Key Features\n\n- Support the OpenAPI request wrapper\n- OpenAPI parameters and request type validation\n- Convenient authentication management\n\n## Installation\n\nInstall using pip:\n\n```bash\npip install zmp-openapi-toolkit\n```\n\nInstall using poetry:\n```bash\npoetry add zmp-openapi-toolkit\n```\n\n## Usage\n\nBasic example:\n\n```python\nimport logging\nimport logging.config\nfrom typing import List\n\nfrom zmp_openapi_toolkit import (\n    MixedAPISpecConfig,\n    ZmpAPIWrapper,\n    ZmpTool,\n    ZmpToolkit,\n)\n\nlogging.getLogger(\"zmp_openapi_toolkit.openapi.zmpapi_models\").setLevel(logging.INFO)\nlogging.getLogger(\"zmp_openapi_toolkit.toolkits.toolkit\").setLevel(logging.INFO)\n\nif __name__ == \"__main__\":\n    mixed_api_spec_config = MixedAPISpecConfig.from_mixed_spec_file(\n        file_path=\"samples/openapi/zmp_mixed_api_spec.json\"\n    )\n\n    zmp_api_wrapper = ZmpAPIWrapper(\n        \"https://your.server.com\", mixed_api_spec_config=mixed_api_spec_config\n    )\n    toolkit = ZmpToolkit.from_zmp_api_wrapper(zmp_api_wrapper=zmp_api_wrapper)\n    tools: List[ZmpTool] = toolkit.get_tools()\n\n```\n\nFor more detailed usage instructions, please refer to our [documentation](link).\n\n## Development Setup\n\n1. Clone the repository\n```bash\ngit clone https://github.com/yourusername/zmp-openapi-toolkit.git\ncd zmp-openapi-toolkit\n```\n\n2. Create and activate virtual environment\n```bash\npython -m venv .venv\nsource .venv/bin/activate  # Windows: venv\\Scripts\\activate\n```\n\n3. Install development dependencies\n```bash\npoetry install\n```\n\n## Contributing\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Contact\n\n- Issue Tracker: https://github.com/yourusername/zmp-openapi-toolkit/issues\n- Email: kilsoo75@gmail.com\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "This is a toolkit library for the LLM application using the multiple openapi specifications",
    "version": "0.1.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/cloudz-mp/zmp-openapi-toolkit/issues",
        "Documentation": "https://github.com/cloudz-mp/zmp-openapi-toolkit",
        "Homepage": "https://github.com/cloudz-mp",
        "Repository": "https://github.com/cloudz-mp/zmp-openapi-toolkit"
    },
    "split_keywords": [
        "llm",
        " toolkit",
        " openapi"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "26514ccf772769024f81b0403f3c544b5f6fd37a7879792b0406bd24e032ddd8",
                "md5": "42d3911b4581d4c699a25b81d883f19b",
                "sha256": "17cddf45a11687291ceceed62d6c13f6a06c01e8ff8336492aff5dbec8f20b88"
            },
            "downloads": -1,
            "filename": "zmp_openapi_toolkit-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "42d3911b4581d4c699a25b81d883f19b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 18548,
            "upload_time": "2025-03-11T02:02:26",
            "upload_time_iso_8601": "2025-03-11T02:02:26.234720Z",
            "url": "https://files.pythonhosted.org/packages/26/51/4ccf772769024f81b0403f3c544b5f6fd37a7879792b0406bd24e032ddd8/zmp_openapi_toolkit-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2999bca7ac51ee9892384aae878522febd8822f94c895fb9e2bec410d633438e",
                "md5": "cc958030301ad003431c09ba9b5540d6",
                "sha256": "3fc3760b996d22bef63b7de94a6031baccd8269f85633c7fcdbed8c4131e6769"
            },
            "downloads": -1,
            "filename": "zmp_openapi_toolkit-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "cc958030301ad003431c09ba9b5540d6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 15406,
            "upload_time": "2025-03-11T02:02:27",
            "upload_time_iso_8601": "2025-03-11T02:02:27.457975Z",
            "url": "https://files.pythonhosted.org/packages/29/99/bca7ac51ee9892384aae878522febd8822f94c895fb9e2bec410d633438e/zmp_openapi_toolkit-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-11 02:02:27",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "cloudz-mp",
    "github_project": "zmp-openapi-toolkit",
    "github_not_found": true,
    "lcname": "zmp-openapi-toolkit"
}
        
Elapsed time: 0.51922s