Metadata-Version: 2.4
Name: freenect
Version: 0.1.0
Summary: Python wrapper for libfreenect - Microsoft Kinect library
Author-email: Dewmina Wijekoon <dewmandula@gmail.com>
Maintainer-email: Dewmina Wijekoon <dewmandula@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/dewminawijekoon/freenect-python
Project-URL: Documentation, https://github.com/dewminawijekoon/freenect-python#readme
Project-URL: Repository, https://github.com/dewminawijekoon/freenect-python.git
Project-URL: Bug Tracker, https://github.com/dewminawijekoon/freenect-python/issues
Keywords: kinect,freenect,computer-vision,depth-camera
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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 :: Cython
Classifier: Topic :: Multimedia :: Graphics :: Capture
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.19.0
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Dynamic: license-file

# libfreenect Python Wrapper

A modern Python 3-compatible wrapper for [libfreenect](https://github.com/OpenKinect/libfreenect), providing access to Microsoft Kinect v1 functionality.

> ⚠️ This project builds upon the original Python wrapper by [Brandyn White](mailto:bwhite@dappervision.com)(https://github.com/bwhite). I have ported and updated it for Python 3 compatibility and ongoing maintenance.

---

## 🚀 Installation

### 🔧 From Source

```bash
git clone https://github.com/dewminawijekoon/freenect-python.git
cd freenect-python
pip install .
```

### 🧪 For Development

```bash
git clone https://github.com/dewminawijekoon/freenect-python.git
cd freenect-python
pip install -e ".[dev]"
```

> 🔜 PyPI installation coming soon.

---

## 📦 Prerequisites

Make sure `libfreenect` is installed on your system before using this wrapper.

Follow the official instructions:
👉 [https://github.com/OpenKinect/libfreenect](https://github.com/OpenKinect/libfreenect)

---

## ⚡ Quick Start

```python
import freenect
import numpy as np

# Capture a depth image
depth, timestamp = freenect.sync_get_depth()
print(f"Depth shape: {depth.shape}")

# Capture an RGB image
rgb, timestamp = freenect.sync_get_video()
print(f"RGB shape: {rgb.shape}")
```

---

## ✨ Features

* Access Kinect depth and RGB video streams
* Synchronous & asynchronous capture modes
* Seamless integration with NumPy
* Cross-platform support (Linux, macOS, Windows)

---

## 📋 Requirements

* Python 3.8+
* NumPy
* libfreenect (installed system-wide)

---

## 📄 License

Licensed under the [Apache License 2.0](LICENSE).

---

## 🤝 Contributing

Contributions are welcome! Feel free to open issues, fork the repo, or submit pull requests.

---

## 🐛 Issues

Encounter a problem? Open an issue and include a detailed description to help us assist you better.
