lightly-purple 0.2.0

Add your description here

Project Purple (Python library)

Structure

Structure of the project is inspired by Kenneth Reitz

README.md
LICENSE
setup.py
requirements.txt
sample/__init__.py
sample/core.py
sample/helpers.py
docs/conf.py
docs/index.rst
tests/test_basic.py
tests/test_advanced.py

We would like to keed modular structure and separate the concerns.

Quickstart

1. Prepare your dataset in YOLO format and ensure you have a dataset.yaml file. For a quick start, you can use the example dataset provided in purple/purple/example.py.

2. Launch the application:

make start

This command will:

• Build both the backend and frontend components
• Start the application
• Automatically open your default browser to http://localhost:8001 (tested on MacOS)

After starting, you'll have access to:

Web application: http://localhost:8001/

Documentation about exposed routes: http://localhost:8001/docs

API endpoints: http://localhost:8001/api

Development

If you are using VS Code I would highly recommend to install the following extensions:

vscode-black

ruff-vscode

Build

make build

Usage example

You can find in the example.py file an example of how to use the library.

from purple.dataset.loader import DatasetLoader

DatasetLoader.launch("some directory from script")