Add details on installing from PyPi in README
Also: - Bump version to `0.1.1` - Pull Docker image rather than building in docker-compose.yml
This commit is contained in:
parent
8026fd88f2
commit
1cf74e13ed
|
@ -1,5 +1,8 @@
|
||||||
FROM python:3.10.5-buster
|
FROM python:3.10.5-buster
|
||||||
|
|
||||||
|
LABEL org.opencontainers.image.description "Dokcer image for running wyzely-detect"
|
||||||
|
LABEL org.opencontainers.image.source "https://github.com/slashtechno/wyzely-detect"
|
||||||
|
|
||||||
RUN apt update && apt install libgl1 -y
|
RUN apt update && apt install libgl1 -y
|
||||||
RUN pip install poetry
|
RUN pip install poetry
|
||||||
|
|
||||||
|
|
16
README.md
16
README.md
|
@ -11,11 +11,12 @@ Recognize faces/objects in a video stream (from a webcam or a security camera) a
|
||||||
|
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
### Poetry/Python
|
### Python
|
||||||
- Camera, either a webcam or a Wyze Cam
|
- Camera, either a webcam or a Wyze Cam
|
||||||
- All RTSP feeds _should_ work, however.
|
- All RTSP feeds _should_ work, however.
|
||||||
- Python 3.10 or 3.11
|
- Python 3.10 or 3.11
|
||||||
- Poetry
|
- Poetry (optional)
|
||||||
|
|
||||||
### Docker
|
### Docker
|
||||||
- A Wyze Cam
|
- A Wyze Cam
|
||||||
- Any other RTSP feed _should_ work, as mentioned above
|
- Any other RTSP feed _should_ work, as mentioned above
|
||||||
|
@ -28,13 +29,20 @@ Recognize faces/objects in a video stream (from a webcam or a security camera) a
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
### Installation
|
### Installation
|
||||||
|
Cloning the repository is not required when installing from PyPi but is required when installing from source
|
||||||
1. Clone this repo with `git clone https://github.com/slashtechno/wyzely-detect`
|
1. Clone this repo with `git clone https://github.com/slashtechno/wyzely-detect`
|
||||||
2. `cd` into the cloned repository
|
2. `cd` into the cloned repository
|
||||||
3. Then, either install with [Poetry](https://python-poetry.org/) or run with Docker
|
3. Then, either install with [Poetry](https://python-poetry.org/) or run with Docker
|
||||||
|
|
||||||
#### Docker
|
#### Docker
|
||||||
1. Modify to `docker-compose.yml` to achieve desired configuration
|
1. Modify to `docker-compose.yml` to achieve desired configuration
|
||||||
2. Run in the background with `docker compose up -d
|
2. Run in the background with `docker compose up -d
|
||||||
|
|
||||||
|
#### Installing from PyPi with pip
|
||||||
|
This assumes you have Python 3.10 or 3.11 installed
|
||||||
|
1. `pip install wyzely-detect`
|
||||||
|
a. You may need to use `pip3` instead of `pip`
|
||||||
|
2. `wyzely-detect`
|
||||||
|
|
||||||
#### Poetry
|
#### Poetry
|
||||||
1. `poetry install`
|
1. `poetry install`
|
||||||
|
|
|
@ -6,8 +6,8 @@ services:
|
||||||
container_name: bridge-wyzely-detect
|
container_name: bridge-wyzely-detect
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
image: mrlt8/wyze-bridge:latest
|
image: mrlt8/wyze-bridge:latest
|
||||||
# I think we can remove the ports, since we're using the network
|
# The ports can be removed since we're using the network
|
||||||
# Just an unnecesary security risk
|
# Just an unnecesary security risk to expose them but can be useful for debugging
|
||||||
# ports:
|
# ports:
|
||||||
# - 1935:1935 # RTMP
|
# - 1935:1935 # RTMP
|
||||||
# - 8554:8554 # RTSP (this is really the only one we need)
|
# - 8554:8554 # RTSP (this is really the only one we need)
|
||||||
|
@ -36,10 +36,11 @@ services:
|
||||||
wyzely-detect:
|
wyzely-detect:
|
||||||
container_name: wyzely-detect
|
container_name: wyzely-detect
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
# image: ghcr.io/slashtechno/wyzely-detect:latest
|
image: ghcr.io/slashtechno/wyzely-detect:latest
|
||||||
build:
|
# Building from source is also an option
|
||||||
context: .
|
# build:
|
||||||
dockerfile: Dockerfile
|
# context: .
|
||||||
|
# dockerfile: Dockerfile
|
||||||
volumes:
|
volumes:
|
||||||
- ./faces:/app/faces
|
- ./faces:/app/faces
|
||||||
networks:
|
networks:
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
[tool.poetry]
|
[tool.poetry]
|
||||||
name = "wyzely-detect"
|
name = "wyzely-detect"
|
||||||
version = "0.1.0"
|
version = "0.1.1"
|
||||||
description = "Recognize faces/objects in a video stream (from a webcam or a security camera) and send notifications to your devices"
|
description = "Recognize faces/objects in a video stream (from a webcam or a security camera) and send notifications to your devices"
|
||||||
authors = ["slashtechno <77907286+slashtechno@users.noreply.github.com>"]
|
authors = ["slashtechno <77907286+slashtechno@users.noreply.github.com>"]
|
||||||
repository = "https://github.com/slashtechno/wyzely-detect"
|
repository = "https://github.com/slashtechno/wyzely-detect"
|
||||||
|
|
Loading…
Reference in New Issue