Metadata-Version: 2.1
Name: person_detector
Version: 0.0.3
Summary: A high level API for detecting and tracking people.
Author-email: k3y5tr0k3 <k3y5tr0k3.software@gmail.com>
Project-URL: Homepage, https://github.com/k3y5tr0k3/person-detector
Project-URL: Issues, https://github.com/k3y5tr0k3/person-detector/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md

# Person Detector

## Highly performant, and accurate, real-time person tracking with YOLOv10 and ByteTrack

### Command-Line Interface

#### Clone repo and navigate to project directory

```bash
git clone git@github.com:k3y5tr0k3/person-detector.git && cd person-detector
```

#### Install requirements

```bash
pip install -r requirements.txt
```

#### Example usage

##### Detections from Image

```bash
python -m src.main --image 'path/to/image.jpg' --detection --show
```

##### Detections from Video

```bash
python -m src.main --video 'path/to/video.mp4' --detection --show
```

##### Trajectory Tracking from Video
```bash
python -m src.main -video 'path/to/video.mp4' --tracking --show
```

##### For more info, use the help flag

```bash
python -m src.main --help
```

### Utility Functions

#### Convert video to images

```bash
python -m src.main --video2images 'path/to/video.mp4
```

### Generate Developer Documentation (Optional)

```bash
pdoc ./src
```

### Using as package in your project

#### Install with PIP

```bash
pip install py-person-detector
```

#### Example Usage

##### Detecting people in an image

```python
import pathlib
from person_detector.detector import Detector

detector = Detector(show=True)

image_path = pathlib.Path("path/to/image.jpg")
detector.detect_image(image_path)
```

