Metadata-Version: 2.1
Name: types-oiio-python
Version: 2.5.12.0.1
Summary: Type stubs for oiio-python
Author: Paul Parneix
Project-URL: Homepage, https://github.com/pypoulp/types-oiio-python
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typing-extensions
Provides-Extra: dev
Requires-Dist: mypy; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: typing-extensions; extra == "dev"
Requires-Dist: oiio-python==2.5.12.0.1; extra == "dev"

# 🔍 **types-oiio-python**

**Type stubs for OpenImageIO Python bindings!**

This package provides type stubs for [oiio-python](https://github.com/pypoulp/oiio-python), enabling static type checking and better IDE support for OpenImageIO and OpenColorIO Python bindings.

---

## **Features**

- **🎯 Complete Type Coverage**: Type hints for OpenImageIO and PyOpenColorIO modules
- **🚀 IDE Support**: Enhanced code completion and type checking
- **✨ MyPy Compatible**: Full support for static type checking
- **🔄 Version Matched**: Stubs versions match `oiio-python` releases

---

## **Installation**

```bash
pip install types-oiio-python
```

It is recommended to add this package to your project development dependencies.



## **Usage**

Once installed, MyPy and your most IDEs will automatically use these stubs for type checking and code completion.
| Autocomplete | Type Checking |
|------------|-------------|
| ![first](https://github.com/pypoulp/types-oiio-python/raw/main/img/auto-complete.jpg) | ![second](https://github.com/pypoulp/types-oiio-python/raw/main/img/type-checking.jpg) |
| (Example in VS Code) | (Example in VS Code) |


## **Version Compatibility**

The version numbers match the corresponding oiio-python releases. For example:
- types-oiio-python 2.5.12.0.x corresponds to oiio-python 2.5.12.0.x

## **Development Notes**

 - The stubs are generated using mypy's stubgen tool.
 - Included `generate_stubs.py` script is used to generate stubs for OpenImageIO and OpenColorIO modules. 
 - Manual adjustments are made to improve the generated stubs.

1. Clone the repository
2. Install in interactive mode with dev dependencies
    ```bash
    pip install -e .[dev]
    ```
1. Test the stubs with MyPy stubtest
    ```bash
    stubtest OpenImageIO --allowlist oiio-mypy-baseline.txt
    stubtest PyOpenColorIO --allowlist ocio-mypy-baseline.txt
    ```
