Metadata-Version: 2.5
Name: cherab-stubs
Version: 1.5.0.1
Summary: Type stubs for cherab
Author-email: Koyo Munechika <munechika.koyo@gmail.com>
License-Expression: EUPL-1.1
License-File: LICENSE
Keywords: cherab,mypy,ray-tracing,type-stubs
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Stubs Only
Requires-Python: >=3.10
Requires-Dist: numpy
Requires-Dist: raysect-stubs<0.10.0,>=0.9.1
Requires-Dist: typing-extensions>=4.6; python_version < '3.12'
Description-Content-Type: text/markdown

# Cherab Stubs

Type stubs for the [Cherab](https://github.com/cherab/core) library, providing type annotations for static type checkers like `mypy`.

## Installation

```bash
pip install cherab-stubs
```

## Usage

Once installed, type checker like `mypy` will automatically use these stubs when type-checking code that uses the Cherab library.

## Development

### Setting up the development environment

1. Clone this repository
2. Install [pixi](https://pixi.sh/) if you haven't already
3. Set up the development environment:
   ```bash
   pixi install
   pixi run test
   ```

### Running type checks

```bash
pixi run type-check
```

### Running tests

```bash
pixi run test
```

### Code formatting and linting

```bash
pixi run lint
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the EUPL-1.1 License - see the LICENSE file for details.
