Metadata-Version: 2.4
Name: fdray
Version: 0.1.14
Summary: A Python interface for POV-Ray (Persistence of Vision Raytracer)
Project-URL: Documentation, https://daizutabi.github.io/fdray/
Project-URL: Source, https://github.com/daizutabi/fdray
Project-URL: Issues, https://github.com/daizutabi/fdray/issues
Author-email: daizutabi <daizutabi@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Daizu
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: 3d,graphics,pov-ray,povray,ray-tracing,rendering
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
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 :: Multimedia :: Graphics :: 3D Rendering
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.11
Requires-Dist: numpy>=2
Requires-Dist: pillow>=10
Description-Content-Type: text/markdown

# fdray - Python Ray Tracing Interface for POV-Ray

[![PyPI Version][pypi-v-image]][pypi-v-link]
[![Python Version][python-v-image]][python-v-link]
[![Build Status][GHAction-image]][GHAction-link]
[![Coverage Status][codecov-image]][codecov-link]

fdray is a Python library that provides a clean interface to POV-Ray,
making it easy to create and render 3D scenes programmatically.

## Features

- **Simple Scene Description**: Express 3D scenes in clean, readable Python code
- **Pythonic API**: Natural integration with Python's ecosystem
- **POV-Ray Integration**: Seamless integration with a high-quality rendering engine
- **Jupyter Support**: Interactive scene development in Jupyter notebooks

## Installation

```bash
pip install fdray
```

Requires POV-Ray to be installed:

- **Linux**: `sudo apt-get install povray`
- **macOS**: `brew install povray`
- **Windows**: Download from [POV-Ray website](https://www.povray.org/download/)

## Quick Start

```python
from fdray import Camera, Color, LightSource, Scene, Sphere

# Create a simple scene
scene = Scene(
    Camera(longitude=20, latitude=30),
    LightSource(0, Color("white")),  # 0: at camera location
    Sphere((0, 0, 0), 1, Color("red")),
)

# Render the scene
scene.render(width=800, height=600)
```

## Documentation

For detailed documentation and examples, visit our
[documentation site](https://daizutabi.github.io/fdray/).

## Contributing

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

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

- POV-Ray team for their excellent ray tracing engine
- The Python community for inspiration and support

<!-- Badges -->
[pypi-v-image]: https://img.shields.io/pypi/v/fdray.svg
[pypi-v-link]: https://pypi.org/project/fdray/
[python-v-image]: https://img.shields.io/pypi/pyversions/fdray.svg
[python-v-link]: https://pypi.org/project/fdray
[GHAction-image]: https://github.com/daizutabi/fdray/actions/workflows/ci.yaml/badge.svg?branch=main&event=push
[GHAction-link]: https://github.com/daizutabi/fdray/actions?query=event%3Apush+branch%3Amain
[codecov-image]: https://codecov.io/github/daizutabi/fdray/coverage.svg?branch=main
[codecov-link]: https://codecov.io/github/daizutabi/fdray?branch=main
