Align docs with AIML examples and update release config

Refactored comments in _version.py to clarify versioning scheme and added release automation marker. Cleaned up release-please-config.json by removing prerelease and extra file settings for improved configuration clarity.

Author: D1m7asis

README.md

@@ -1,5 +1,8 @@
 # Shared Types
 
+> The examples below reference the upstream `openai` namespace. When using the AI/ML API package, you can import the same
+> classes and helpers from `aimlapi` while preserving compatibility with the OpenAI SDK surface.
+
 ```python
 from openai.types import (
     AllModels,

api.md

@@ -1,6 +1,6 @@
 # Structured Outputs Parsing Helpers
 
-The OpenAI API supports extracting JSON from the model with the `response_format` request param, for more details on the API, see [this guide](https://platform.openai.com/docs/guides/structured-outputs).
+The AI/ML API supports extracting JSON from the model with the `response_format` request param (see [the guide](https://docs.aimlapi.com/guides/structured-outputs)) and remains fully compatible with the upstream OpenAI client surface.
 
 The SDK provides a `client.chat.completions.parse()` method which is a wrapper over the `client.chat.completions.create()` that
 provides richer integrations with Python specific types & returns a `ParsedChatCompletion` object, which is a subclass of the standard `ChatCompletion` class.
@@ -13,7 +13,7 @@ into a JSON schema, send it to the API and parse the response content back into
 ```py
 from typing import List
 from pydantic import BaseModel
-from openai import OpenAI
+from aimlapi import AIMLAPI
 
 class Step(BaseModel):
     explanation: str
@@ -23,7 +23,7 @@ class MathResponse(BaseModel):
     steps: List[Step]
     final_answer: str
 
-client = OpenAI()
+client = AIMLAPI()
 completion = client.chat.completions.parse(
     model="gpt-4o-2024-08-06",
     messages=[
@@ -45,7 +45,7 @@ else:
 
 The `.parse()` method will also automatically parse `function` tool calls if:
 
-- You use the `openai.pydantic_function_tool()` helper method
+- You use the `aimlapi.pydantic_function_tool()` helper method
 - You mark your tool schema with `"strict": True`
 
 For example:
@@ -54,7 +54,7 @@ For example:
 from enum import Enum
 from typing import List, Union
 from pydantic import BaseModel
-import openai
+import aimlapi
 
 class Table(str, Enum):
     orders = "orders"
@@ -96,7 +96,7 @@ class Query(BaseModel):
     conditions: List[Condition]
     order_by: OrderBy
 
-client = openai.OpenAI()
+client = aimlapi.AIMLAPI()
 completion = client.chat.completions.parse(
     model="gpt-4o-2024-08-06",
     messages=[
@@ -110,7 +110,7 @@ completion = client.chat.completions.parse(
         },
     ],
     tools=[
-        openai.pydantic_function_tool(Query),
+        aimlapi.pydantic_function_tool(Query),
     ],
 )
 
@@ -140,9 +140,9 @@ It also supports all aforementioned [parsing helpers](#structured-outputs-parsin
 Unlike `.create(stream=True)`, the `.stream()` method requires usage within a context manager to prevent accidental leakage of the response:
 
 ```py
-from openai import AsyncOpenAI
+from aimlapi import AsyncAIMLAPI
 
-client = AsyncOpenAI()
+client = AsyncAIMLAPI()
 
 async with client.chat.completions.stream(
     model='gpt-4o-2024-08-06',
@@ -223,7 +223,7 @@ Emitted when a function tool call's arguments are complete.
 - `name`: The name of the function being called
 - `index`: The index of the tool call
 - `arguments`: The full raw JSON string of arguments
-- `parsed_arguments`: The fully parsed arguments object. If you used `openai.pydantic_function_tool()` this will be an instance of the given model.
+- `parsed_arguments`: The fully parsed arguments object. If you used `aimlapi.pydantic_function_tool()` this will be an instance of the given model.
 
 #### LogprobsContentDeltaEvent
 
@@ -294,11 +294,11 @@ You can subscribe to events by creating an event handler class and overloading t
 
 ```python
 from typing_extensions import override
-from openai import AssistantEventHandler, OpenAI
-from openai.types.beta.threads import Text, TextDelta
-from openai.types.beta.threads.runs import ToolCall, ToolCallDelta
+from aimlapi import AIMLAPI, AssistantEventHandler
+from aimlapi.types.beta.threads import Text, TextDelta
+from aimlapi.types.beta.threads.runs import ToolCall, ToolCallDelta
 
-client = openai.OpenAI()
+client = AIMLAPI()
 
 # First, we create a EventHandler class to define
 # how we want to handle the events in the response stream.

helpers.md

@@ -1,11 +1,11 @@
 [project]
-name = "openai"
+name = "aimlapi"
 version = "2.8.1"
-description = "The official Python library for the openai API"
+description = "AI/ML API Python SDK"
 dynamic = ["readme"]
 license = "Apache-2.0"
 authors = [
-{ name = "OpenAI", email = "support@openai.com" },
+{ name = "AI/ML API", email = "help@aimlapi.com" },
 ]
 dependencies = [
     "httpx>=0.23.0, <1",
@@ -36,11 +36,11 @@ classifiers = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/openai/openai-python"
-Repository = "https://github.com/openai/openai-python"
+Homepage = "https://docs.aimlapi.com"
+Repository = "https://github.com/aimlapi/aimlapi-python"
 
 [project.scripts]
-openai = "openai.cli:main"
+aimlapi = "aimlapi.cli._cli:main"
 
 [project.optional-dependencies]
 aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.9"]
@@ -92,7 +92,7 @@ format = { chain = [
 "check:ruff" = "ruff check ."
 "fix:ruff" = "ruff check --fix ."
 
-"check:importable" = "python -c 'import openai'"
+"check:importable" = "python -c 'import aimlapi'"
 
 typecheck = { chain = [
   "typecheck:pyright",
@@ -112,7 +112,7 @@ include = [
 ]
 
 [tool.hatch.build.targets.wheel]
-packages = ["src/openai"]
+packages = ["src/openai", "src/aimlapi"]
 
 [tool.hatch.build.targets.sdist]
 # Basically everything except hidden files/directories (such as .github, .devcontainers, .python-version, etc)
@@ -138,7 +138,7 @@ path = "README.md"
 [[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
 # replace relative links with absolute links
 pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)'
-replacement = '[\1](https://github.com/openai/openai-python/tree/main/\g<2>)'
+replacement = '[\1](https://github.com/aimlapi/aimlapi-python/tree/main/\g<2>)'
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]

pyproject.toml

@@ -1,16 +1,22 @@
 {
-  "packages": {
-    ".": {}
-  },
   "$schema": "https://raw.githubusercontent.com/stainless-api/release-please/main/schemas/config.json",
   "include-v-in-tag": true,
   "include-component-in-tag": false,
-  "versioning": "prerelease",
-  "prerelease": true,
   "bump-minor-pre-major": true,
   "bump-patch-for-minor-pre-major": false,
   "pull-request-header": "Automated Release PR",
   "pull-request-title-pattern": "release: ${version}",
+  "packages": {
+    ".": {
+      "release-type": "python",
+      "package-name": "aimlapi",
+      "extra-files": [
+        "pyproject.toml",
+        "src/aimlapi/_version.py",
+        "src/openai/_version.py"
+      ]
+    }
+  },
   "changelog-sections": [
     {
       "type": "feat",
@@ -58,9 +64,5 @@
       "section": "Continuous Integration",
       "hidden": true
     }
-  ],
-  "release-type": "python",
-  "extra-files": [
-    "src/openai/_version.py"
   ]
-}
+}

release-please-config.json

@@ -33,6 +33,8 @@
     AzureAIMLAPIWithStreamedResponse,
     Client,
 )
+from ._client import DEFAULT_BASE_URL
+from ._version import __title__, __version__
 
 AzureOpenAI = AzureAIMLAPI
 AsyncAzureOpenAI = AsyncAzureAIMLAPI
@@ -55,7 +57,7 @@ def _first_env(*names: str) -> str | None:
 organization: str | None = None
 project: str | None = None
 webhook_secret: str | None = None
-base_url: str | httpx.URL | None = _first_env(*_BASE_URL_ENV_VARS)
+base_url: str | httpx.URL | None = _first_env(*_BASE_URL_ENV_VARS) or DEFAULT_BASE_URL
 websocket_base_url: str | httpx.URL | None = None
 timeout: float | Timeout | None = DEFAULT_TIMEOUT
 max_retries: int = DEFAULT_MAX_RETRIES
@@ -117,6 +119,8 @@ def _get_default_client() -> AIMLAPI:
     dict.fromkeys(
         [
             *_openai_all,
+            "__title__",
+            "__version__",
             "AIMLAPI",
             "AsyncAIMLAPI",
             "AIMLAPIWithRawResponse",

src/aimlapi/__init__.py

@@ -0,0 +1,9 @@
+"""
+Version information for the AI/ML API package.
+
+This project is a fork of the OpenAI Python SDK, and the __version__
+value follows the same versioning scheme for compatibility.
+"""
+
+__title__ = "aimlapi"
+__version__ = "2.8.1"  # x-release-please-version

src/aimlapi/_version.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-from openai.version import *  # noqa: F401, F403
+from ._version import *  # noqa: F401, F403