Metadata-Version: 2.1
Name: openai-func-parser
Version: 0.1.0
Summary: Transform Python function docstrings into JSON schemas compliant with OpenAI function calling protocols.
License: MIT
Author: Xiaotian Duan
Author-email: xduan7@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: docstring-parser (>=0.15,<0.16)
Requires-Dist: openai (>=1.1.1,<2.0.0)
Description-Content-Type: text/markdown

# OpenAI Function Parser

Transform Python function docstrings into JSON schemas compliant with OpenAI function calling protocols.


## Installation

```bash
pip install openai-function-parser
```

## Usage

```python

from openai_function_parser import get_function_calling_schema


def my_function(a: int, b: str, c: float = 1.0) -> int:
    """
    My function description.

    Args:
        a: My first argument.
        b: My second argument.
        c: My third argument.

    Returns:
        My return value.
    """
    return 1

function_call_schema = get_function_calling_schema(my_function)
print(function_call_schema)
```


## Authors

Xiaotian Duan (xduan7 at gmail dot com)

