init oci-openai

Author: upfixer

.gitignore

@@ -0,0 +1,80 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+.idea/
+
+# Visual Studio Code
+.vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

CONTRIBUTING.md

@@ -1,5 +1,3 @@
-*Detailed instructions on how to contribute to the project, if applicable. Must include section about Oracle Contributor Agreement with link and instructions*
-
 # Contributing to this repository
 
 We welcome your contributions! There are multiple ways to contribute.

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2023 Oracle and/or its affiliates.
+Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
 
 The Universal Permissive License (UPL), Version 1.0
 

Makefile

@@ -0,0 +1,50 @@
+# Define the directory containing the source code
+SRC_DIR := ./src
+TEST_DIR := ./tests
+
+
+.PHONY: all
+all: test lint build
+
+##@ General
+
+.PHONY: help
+help: ## Display this help.
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-24s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+##@ Development
+
+.PHONY: install
+install: ## Install project dependencies.
+	uv pip install --editable .
+
+.PHONY: dev
+dev: ## Install development dependencies.
+	uv pip install ".[dev]"
+
+.PHONY: test
+test: ## Run tests.
+	uv run --no-reinstall pytest $(TEST_DIR) --cov --cov-config=.coveragerc -vv -s
+
+.PHONY: clean
+clean: ## Remove build artifacts.
+	rm -rf build dist *.egg-info .pytest_cache .coverage
+
+.PHONY: format
+format: ## Format code using ruff.
+	uv run --no-reinstall isort $(SRC_DIR) $(TEST_DIR)
+	uv run --no-reinstall ruff format $(SRC_DIR) $(TEST_DIR); uv run --no-reinstall ruff check --fix $(SRC_DIR) $(TEST_DIR)
+
+.PHONY: lint
+lint: ## Run linters using ruff.
+	uv run --no-reinstall ruff format --diff $(SRC_DIR) $(TEST_DIR)
+	uv run --no-reinstall mypy $(SRC_DIR)
+
+.PHONY: check
+check: format lint ## Run format and lint.
+
+##@ Build
+
+.PHONY: build
+build: ## Build the application.
+	uv build

README.md

@@ -1,29 +1,50 @@
-*This repository acts as a template for all of Oracle’s GitHub repositories. It contains information about the guidelines for those repositories. All files and sections contained in this template are mandatory, and a GitHub app ensures alignment with these guidelines. To get started with a new repository, replace the italic paragraphs with the respective text for your project.*
+# oci-openai
 
-# Project name
+[![PyPI - Version](https://img.shields.io/pypi/v/oci-openai.svg)](https://pypi.org/project/oci-openai)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/oci-openai.svg)](https://pypi.org/project/oci-openai)
 
-*Describe your project's features, functionality and target audience*
+OCI-OpenAI is a client library maintained by the Oracle Cloud Infrastructure (OCI) [Generative AI Service](https://docs.oracle.com/en-us/iaas/Content/generative-ai/home.htm) team.
+This package simplifies integration between OpenAI’s Python SDK and Oracle Cloud Infrastructure (OCI) GenAI service by providing robust authentication and authorization utilities.
+Developers can seamlessly connect to Oracle Generative AI services using OCI credentials, ensuring secure and compliant access while leveraging industry best practices.
 
-## Installation
-
-*Provide detailed step-by-step installation instructions. You can name this section **How to Run** or **Getting Started** instead of **Installation** if that's more acceptable for your project*
+-----
 
-## Documentation
+## Table of Contents
 
-*Developer-oriented documentation can be published on GitHub, but all product documentation must be published on <https://docs.oracle.com>*
+- [Installation](#installation)
+- [License](#license)
 
-## Examples
+## Installation
 
-*Describe any included examples or provide a link to a demo/tutorial*
+```console
+pip install oci-openai
+```
 
-## Help
+## Examples
 
-*Inform users on where to get help or how to receive official support from Oracle (if applicable)*
+```python
+from oci_openai import OciOpenAI, OciSessionAuth
+
+client = OciOpenAI(
+    service_endpoint="https://inference.generativeai.us-chicago-1.oci.oraclecloud.com",
+    auth=OciSessionAuth(profile_name="<profile name>"),
+    compartment_id="<compartment ocid>",
+)
+
+completion = client.chat.completions.create(
+    model="<model name>",
+    messages=[
+        {
+            "role": "user",
+            "content": "How do I output all files in a directory using Python?",
+        },
+    ],
+)
+print(completion.model_dump_json())
+```
 
 ## Contributing
 
-*If your project has specific contribution requirements, update the CONTRIBUTING.md file to ensure those requirements are clearly explained*
-
 This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
 
 ## Security
@@ -32,13 +53,7 @@ Please consult the [security guide](./SECURITY.md) for our responsible security
 
 ## License
 
-*The correct copyright notice format for both documentation and software is*
-    "Copyright (c) [year,] year Oracle and/or its affiliates."
-*You must include the year the content was first released (on any platform) and the most recent year in which it was revised*
-
-Copyright (c) 2023 Oracle and/or its affiliates.
-
-*Replace this statement if your project is not licensed under the UPL*
+Copyright (c) 2025 Oracle and/or its affiliates.
 
 Released under the Universal Permissive License v1.0 as shown at
-<https://oss.oracle.com/licenses/upl/>.
+<https://oss.oracle.com/licenses/upl/>