Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/cicd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ jobs:
matrix:
python-version: [
#"3.6", # Default on Ubuntu18.04 but openapi-generator fails
"3.7", # EOL but we're still supporting it for now.
# "3.7", # Removed support as of 0.17
"3.8",
"3.9",
"3.10",
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ share/python-wheels/
.installed.cfg
*.egg
MANIFEST
poetry.lock

# PyInstaller
# Usually these files are written by a python script from a template
Expand Down
2 changes: 1 addition & 1 deletion .pylintrc
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ persistent=yes

# Min Python version to use for version dependend checks. Will default to the
# version used to run pylint.
py-version=3.7
py-version=3.8

# When enabled, pylint would attempt to guess common misconfiguration and emit
# user-friendly hints instead of false-positive error messages.
Expand Down
2 changes: 1 addition & 1 deletion DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ you can install the package dependencies by running:
make install
```

Note: We support Python 3.7+ for clients of the SDK, but we recommend developing with Python 3.10+.
Note: We support Python 3.8+ for clients of the SDK, but we recommend developing with Python 3.10+.

### Run tests

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/getting-started/3-retail-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ To implement this retail analytics solution, a store would need to install a sup

## Requirements

- [Groundlight SDK](/docs/installation/) with Python 3.7 or higher
- [Groundlight SDK](/docs/installation/) with Python 3.8 or higher
- A supported USB or network-connected camera
- An email account with SMTP access to send the daily log

## Installation

Ensure you have Python 3.7 or higher installed, and then install the Groundlight SDK, OpenCV library, and other required libraries:
Ensure you have Python 3.8 or higher installed, and then install the Groundlight SDK, OpenCV library, and other required libraries:

```bash
pip install groundlight opencv-python pillow
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/getting-started/4-dog-on-couch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Here is a whimsical example of how you could use Groundlight in your home to kee

## Requirements

- [Groundlight SDK](/docs/installation/) with Python 3.7 or higher
- [Groundlight SDK](/docs/installation/) with Python 3.8 or higher
- A supported USB or network-connected camera
- A pre-recorded sound file (e.g., `get_off_couch.mp3`)
- A couch and a dog are recommended for proper end-to-end testing.

## Installation

Ensure you have Python 3.7 or higher installed, and then install the Groundlight SDK and OpenCV library:
Ensure you have Python 3.8 or higher installed, and then install the Groundlight SDK and OpenCV library:

```bash
pip install groundlight opencv-python pillow pyaudio
Expand Down
16 changes: 8 additions & 8 deletions docs/docs/getting-started/5-streaming.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# A Quick Example: Live Stream Alert
# A Quick Example: Live Stream Alert

A quick example to get used to setting up detectors and asking good questions: set up a monitor on a live stream.
A quick example to get used to setting up detectors and asking good questions: set up a monitor on a live stream.

## Requirements

- [Groundlight SDK](/docs/installation/) with Python 3.7 or higher
- [Groundlight SDK](/docs/installation/) with Python 3.8 or higher
- The video ID of a YouTube live stream you'd like to monitor

## Installation

Ensure you have Python 3.7 or higher installed, and then install the Groundlight SDK and OpenCV library:
Ensure you have Python 3.8 or higher installed, and then install the Groundlight SDK and OpenCV library:

```bash
# MacOS
Expand All @@ -29,15 +29,15 @@ pip install groundlight pillow ffmpeg yt-dlp typer
#!/bin/bash

ffmpeg -i "$(yt-dlp -g $1 | head -n 1)" -vframes 1 last.jpg -y
```
```

This will download the most recent frame from a YouTube live stream and save it to a local file `last.jpg`.
This will download the most recent frame from a YouTube live stream and save it to a local file `last.jpg`.

2. Ensure that the script has execute permissions. You can add execute permissions using the following command:

```
chmod +x get_latest_frame.sh
```
```

3. Log in to the [Groundlight application](https://app.groundlight.ai) and get an [API Token](api-tokens).

Expand Down Expand Up @@ -65,7 +65,7 @@ def main(*, video_id: str = None, detector_name: str = None, query: str = None,
p = subprocess.run(["./get_latest_frame.sh", video_id])
if p.returncode != 0:
raise RuntimeError(f"Could not get image from video ID: {video_id}. Process exited with return code {p.returncode}.")

image = Image.open("last.jpg").convert("RGB")
response = gl.submit_image_query(detector=detector, image=image, wait=wait)

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Groundlight's Escalation Technology combines the power of generative AI using ou

## Building a simple visual application

1. Install the `groundlight` SDK. Requires python version 3.7 or higher. See [prerequisites](#Prerequisites).
1. Install the `groundlight` SDK. Requires python version 3.8 or higher. See [prerequisites](#Prerequisites).

```shell
pip3 install groundlight
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/installation/1-linux.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Installing on Linux

This guide will help you install the Groundlight SDK on Linux. The Groundlight SDK requires Python 3.7 or higher.
This guide will help you install the Groundlight SDK on Linux. The Groundlight SDK requires Python 3.8 or higher.

## Prerequisites

Ensure that you have the following installed on your system:

- Python 3.7 or higher
- Python 3.8 or higher
- pip (Python package installer)

## Basic Installation

Assuming you have Python 3.7 or higher installed on your system, you can proceed with the following steps to install or upgrade the Groundlight SDK:
Assuming you have Python 3.8 or higher installed on your system, you can proceed with the following steps to install or upgrade the Groundlight SDK:

### Installing Groundlight SDK

Expand Down Expand Up @@ -61,7 +61,7 @@ To check your installed Python version, open a terminal and run:
python --version
```

If you see a version number starting with "3.7" or higher (e.g., "3.7.5" or "3.9.0"), you're good to go. If not, you might need to upgrade Python on your system.
If you see a version number starting with "3.8" or higher (e.g., "3.8.5" or "3.9.0"), you're good to go. If not, you might need to upgrade Python on your system.

### Upgrading Python on Linux

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/installation/2-macos.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Installing on macOS

This guide will help you install the Groundlight SDK on macOS. The Groundlight SDK requires Python 3.7 or higher.
This guide will help you install the Groundlight SDK on macOS. The Groundlight SDK requires Python 3.8 or higher.

## Prerequisites

Ensure that you have the following installed on your system:

- Python 3.7 or higher
- Python 3.8 or higher
- pip (Python package installer)

## Basic Installation

Assuming you have Python 3.7 or higher installed on your system, you can proceed with the following steps to install or upgrade the Groundlight SDK:
Assuming you have Python 3.8 or higher installed on your system, you can proceed with the following steps to install or upgrade the Groundlight SDK:

### Installing Groundlight SDK

Expand Down Expand Up @@ -61,7 +61,7 @@ To check your installed Python version, open a terminal and run:
python --version
```

If you see a version number starting with "3.7" or higher (e.g., "3.7.5" or "3.9.0"), you're good to go. If not, you might need to upgrade Python on your system.
If you see a version number starting with "3.8" or higher (e.g., "3.8.5" or "3.9.0"), you're good to go. If not, you might need to upgrade Python on your system.

### Upgrading Python on MacOS

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/installation/3-windows.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Installing on Windows

This guide will help you install the Groundlight SDK on Windows. The Groundlight SDK requires Python 3.7 or higher.
This guide will help you install the Groundlight SDK on Windows. The Groundlight SDK requires Python 3.8 or higher.

## Prerequisites

Ensure that you have the following installed on your system:

- Python 3.7 or higher
- Python 3.8 or higher
- pip (Python package installer)

## Basic Installation

Assuming you have Python 3.7 or higher installed on your system, you can proceed with the following steps to install or upgrade the Groundlight SDK:
Assuming you have Python 3.8 or higher installed on your system, you can proceed with the following steps to install or upgrade the Groundlight SDK:

### Installing Groundlight SDK

Expand Down Expand Up @@ -61,7 +61,7 @@ To check your installed Python version, open a Command Prompt and run:
python --version
```

If you see a version number starting with "3.7" or higher (e.g., "3.7.5" or "3.9.0"), you're good to go. If not, you might need to upgrade Python on your system.
If you see a version number starting with "3.8" or higher (e.g., "3.8.5" or "3.9.0"), you're good to go. If not, you might need to upgrade Python on your system.

### Upgrading Python on Windows

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/installation/4-raspberry-pi.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Installing on Raspberry Pi

This guide will help you install the Groundlight SDK on Raspberry Pi. The Groundlight SDK requires Python 3.7 or higher.
This guide will help you install the Groundlight SDK on Raspberry Pi. The Groundlight SDK requires Python 3.8 or higher.

## Prerequisites

Ensure that you have the following installed on your Raspberry Pi:

- Python 3.7 or higher
- Python 3.8 or higher
- pip (Python package installer)

## Basic Installation

Assuming you have Python 3.7 or higher installed on your Raspberry Pi, you can proceed with the following steps to install or upgrade the Groundlight SDK:
Assuming you have Python 3.8 or higher installed on your Raspberry Pi, you can proceed with the following steps to install or upgrade the Groundlight SDK:

### Installing Groundlight SDK

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/installation/5-nvidia-jetson.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Installing on NVIDIA Jetson

This guide will help you install the Groundlight SDK on NVIDIA Jetson devices. The Groundlight SDK requires Python 3.7 or higher.
This guide will help you install the Groundlight SDK on NVIDIA Jetson devices. The Groundlight SDK requires Python 3.8 or higher.

## Prerequisites

Ensure that you have the following installed on your NVIDIA Jetson:

- Python 3.7 or higher
- Python 3.8 or higher
- pip (Python package installer)

## Basic Installation

Assuming you have Python 3.7 or higher installed on your NVIDIA Jetson, you can proceed with the following steps to install or upgrade the Groundlight SDK:
Assuming you have Python 3.8 or higher installed on your NVIDIA Jetson, you can proceed with the following steps to install or upgrade the Groundlight SDK:

### Installing Groundlight SDK

Expand Down
Loading