🚀 Getting Started

Prerequisites

You'll need to install:

• just
• poetry

Setup

Install the dependencies

$ just setup

Usage

$ poetry run ./ova.py detection /path/to/image

The available options for the cli:

$ poetry run ./ova.py detection --help
Usage: ova_client.py detection [OPTIONS] IMAGE

Options:
  -s, --save       Save the output image.
  -v, --visualize  Draw bounding boxes on the detected objects.
  --help           Show this message and exit.

Want to use httpie ?

$ pip install --user httpie
$ http -f POST https://api.openvisionapi.com/api/v1/detection  model="yolov4" image@images/cat.jpeg

{
    "description": "Detected objects",
    "predictions": [
        {
            "bbox": {
                "x1": 442,
                "x2": 982,
                "y1": 199,
                "y2": 1270
            },
            "label": "cat",
            "score": "0.93"
        }
    ]
}

Want to use curl ?

$ curl -X POST https://api.openvisionapi.com/api/v1/detection \
  -F "model=yolov4" \
  -F "image=@images/cat.jpeg"

{
  "description": "Detected objects",
  "predictions": [
    {
      "bbox": {
        "x1": 442,
        "x2": 982,
        "y1": 199,
        "y2": 1270
      },
      "label": "cat",
      "score": "0.93"
    }
  ]
}

Configuration

The configuration can be set up using the following env variables:

OVA_DETECTION_URL : The URL to the OpenVisionAPI server. The default is https://api.openvisionapi.com/api/v1/detection

OVA_OUTPUT_DIR : The directory where to store the result. The default is ./output

⛏️ Built Using

• Pillow
• click
• requests
• pygments

🤝 Contributing

Your contributions are welcome !

Setting up development environment

To setup the development environment, simply run this command

$ just dev

Code-style checks

ruff and mypy are used to ensure that contributions are stylized in a uniform manner.

• ruff is used as a linter and a code formatter.
• mypy is used for static typing

🔧 Tests

To run the tests, simply run those commands

$ just dev
$ just test

⚖️ License

AGPLv3