Skip to main content

Toolkit for fast and flexible integration with Azure OpenAI

Project description

PyPI Version PyPI Downloads GitHub Tag License Repo Size Python Version

Last Commit Commits Per Month Build Status Security Scan

GitHub Stars Contributors Open Issues Open PRs

Author LinkedIn


rsazure-openai-toolkit

A lightweight, independent toolkit to simplify and accelerate integration with Azure OpenAI.


Installation

From PyPI:

pip install rsazure-openai-toolkit

From GitHub:

pip install git+https://github.com/renan-siqueira/rsazure-openai-toolkit

Usage

from rsazure_openai_toolkit import call_azure_openai_handler

response = call_azure_openai_handler(
    api_key="your-api-key",
    azure_endpoint="https://your-resource.openai.azure.com/",
    api_version="2023-12-01-preview",
    deployment_name="gpt-35-turbo",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Summarize what artificial intelligence is."}
    ]
)

print(response)

Environment Configuration

To simplify local development and testing, this toolkit supports loading environment variables from a .env file.

Create a .env file in your project root (or copy the provided .env.example) and add your Azure OpenAI credentials:

AZURE_OPENAI_API_KEY=your-api-key
AZURE_OPENAI_ENDPOINT=https://your-resource.openai.azure.com/
AZURE_OPENAI_API_VERSION=2023-12-01-preview
AZURE_DEPLOYMENT_NAME=your-deployment-name

In your script, load the environment variables before calling the handler:

from dotenv import load_dotenv
import os

load_dotenv()  # defaults to loading from .env in the current directory

from rsazure_openai_toolkit import call_azure_openai_handler

response = call_azure_openai_handler(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),
    azure_endpoint=os.getenv("AZURE_OPENAI_ENDPOINT"),
    api_version=os.getenv("AZURE_OPENAI_API_VERSION"),
    deployment_name=os.getenv("AZURE_DEPLOYMENT_NAME"),
    messages=[...]
)

Features

  • Modular and easy to extend
  • Retry mechanism with exponential backoff
  • Accepts OpenAI-compatible parameters
  • Ready for production use

Requirements

  • Python 3.9+
  • Azure OpenAI resource and deployment

License

This project is open-sourced and available to everyone under the MIT License.


🚨 Possible Issues

  • Invalid API Key or Endpoint
    Ensure your AZURE_OPENAI_API_KEY and AZURE_OPENAI_ENDPOINT are correctly set in your .env file.

  • Deployment Not Found
    Check that your deployment_name matches exactly the name defined in your Azure OpenAI resource.

  • Timeouts or 5xx Errors
    The toolkit includes automatic retries with exponential backoff via tenacity. If errors persist, verify network access or Azure service status.

  • Missing Environment Variables
    Always ensure load_dotenv() is called before accessing os.getenv(...), especially when testing locally.


📝 Changelog

Check the Releases page for updates and version history.


🛡️ Security

If you discover any security issues, please report them privately via email: renan.siqu@gmail.com.


🤝 Contributing

Contributions are welcome! Feel free to open issues or pull requests.

To contribute:

  1. Fork the repo
  2. Create a feature branch (git checkout -b feature/my-feature)
  3. Commit your changes
  4. Open a PR

Please follow PEP8 and ensure your code passes existing tests.


🧠 Design Principles

  • Simplicity over complexity
  • Focus on production-readiness
  • Explicit configuration
  • Easy to extend and maintain

👨‍💻 About the Author

Hi, I'm Renan Siqueira Antonio — a technical leader in Artificial Intelligence with hands-on experience in delivering real-world AI solutions across different industries.

Over the years, I've had the opportunity to collaborate with incredible teams and contribute to initiatives recognized by companies.

This project was born from a personal need: to create a clean, reusable, and production-ready way to interact with Azure OpenAI. I'm sharing it with the hope that it helps others move faster and build better.


📬 Contact

Feel free to reach out via:

Contributions, suggestions, and bug reports are welcome!

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

rsazure_openai_toolkit-0.1.3.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

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

rsazure_openai_toolkit-0.1.3-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file rsazure_openai_toolkit-0.1.3.tar.gz.

File metadata

  • Download URL: rsazure_openai_toolkit-0.1.3.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for rsazure_openai_toolkit-0.1.3.tar.gz
Algorithm Hash digest
SHA256 b9115fdc5755dbe9b536827f907fd2f8bc528750e0ade0cb4f6fef271aaea143
MD5 70c1ed825b01c15e02253741adacdd65
BLAKE2b-256 e2f9115e13a04e9fa26c86f943259d8d127543e2c49a9617c489cec6b1c51497

See more details on using hashes here.

File details

Details for the file rsazure_openai_toolkit-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for rsazure_openai_toolkit-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a14569697d07d9996802fb8eac97ac25f79a454c3c2f70a0748aa886a6ac66ca
MD5 2861f7f7e4425bc75688012d0183058a
BLAKE2b-256 175fb92aaae6647faa4cab5f246b440cc9a3daddc3b537e7c1388ff486640a47

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