| Name | set-detect-notify JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | Detect all the things |
| upload_time | 2023-10-21 21:33:50 |
| maintainer | |
| docs_url | None |
| author | slashtechno |
| requires_python | >=3.10,<3.12 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Set, Detect, Notify
Recognize faces/objects in (Wyze Cam) footage and send notifications to your phone (or other devices)
### Features
- Recognize objects
- Recognize faces
- Send notifications to your phone (or other devices) using [ntfy](https://ntfy.sh/)
- Optionally, run headless with Docker
- Either use a webcam or an RTSP feed
- Use [mrlt8/docker-wyze-bridge](https://github.com/mrlt8/docker-wyze-bridge) to get RTSP feeds from Wyze Cams
## Prerequisites
### Poetry/Python
- Camera, either a webcam or a Wyze Cam
- All RTSP feeds _should_ work, however.
- Python
- Poetry
### Docker
- A Wyze Cam
- Any other RTSP feed _should_ work, as mentioned above
- Python
- Poetry
## What's not required
- A Wyze subscription
## Usage
### Installation
1. Clone this repo with `git clone https://github.com/slashtechno/wyze-face-recognition.git`
2. `cd` into the cloned repository
3. Then, either install with [Poetry](https://python-poetry.org/) or run with Docker
#### Docker
1. Modify to `docker-compose.yml` to achieve desired configuration
2. Run in the background with `docker compose up -d
#### Poetry
1. `poetry install`
2. `poetry run -- set-detect-notify`
### Configuration
The following are some basic CLI options. Most flags have environment variable equivalents which can be helpful when using Docker.
- For face recognition, put images of faces in subdirectories `./faces` (this can be changed with `--faces-directory`)
- Keep in mind, on the first run, face rec
- By default, notifications are sent for all objects. This can be changed with one or more occurrences of `--detect-object` to specify which objects to detect
- Currently, all classes in the [COCO](https://cocodataset.org/) dataset can be detected
- To specify where notifications are sent, specify a [ntfy](https://ntfy.sh/) URL with `--ntfy-url`
- To configure the program when using Docker, edit `docker-compose.yml` and/or set environment variables.
- **For further information, use `--help`**
### How to uninstall
- If you used Docker, run `docker-compose down --rmi all` in the cloned repository
- If you used Poetry, just delete the virtual environment and then the cloned repository
Raw data
{
"_id": null,
"home_page": "",
"name": "set-detect-notify",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<3.12",
"maintainer_email": "",
"keywords": "",
"author": "slashtechno",
"author_email": "77907286+slashtechno@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/cf/df/910a8b1a647ad35b2311468f537c8a4f899a7c4c299c4fd3c5305f3469ba/set_detect_notify-0.1.0.tar.gz",
"platform": null,
"description": "# Set, Detect, Notify \nRecognize faces/objects in (Wyze Cam) footage and send notifications to your phone (or other devices)\n\n### Features \n- Recognize objects \n- Recognize faces \n- Send notifications to your phone (or other devices) using [ntfy](https://ntfy.sh/) \n- Optionally, run headless with Docker \n- Either use a webcam or an RTSP feed \n - Use [mrlt8/docker-wyze-bridge](https://github.com/mrlt8/docker-wyze-bridge) to get RTSP feeds from Wyze Cams \n\n\n## Prerequisites \n### Poetry/Python \n- Camera, either a webcam or a Wyze Cam \n - All RTSP feeds _should_ work, however.\n- Python\n- Poetry\n### Docker\n- A Wyze Cam \n - Any other RTSP feed _should_ work, as mentioned above\n- Python\n- Poetry\n\n## What's not required \n- A Wyze subscription \n\n## Usage \n### Installation \n1. Clone this repo with `git clone https://github.com/slashtechno/wyze-face-recognition.git` \n2. `cd` into the cloned repository \n3. Then, either install with [Poetry](https://python-poetry.org/) or run with Docker \n\n#### Docker \n1. Modify to `docker-compose.yml` to achieve desired configuration\n2. Run in the background with `docker compose up -d\n\n#### Poetry \n1. `poetry install` \n2. `poetry run -- set-detect-notify` \n### Configuration \nThe following are some basic CLI options. Most flags have environment variable equivalents which can be helpful when using Docker. \n\n- For face recognition, put images of faces in subdirectories `./faces` (this can be changed with `--faces-directory`) \n - Keep in mind, on the first run, face rec\n- By default, notifications are sent for all objects. This can be changed with one or more occurrences of `--detect-object` to specify which objects to detect\n - Currently, all classes in the [COCO](https://cocodataset.org/) dataset can be detected\n- To specify where notifications are sent, specify a [ntfy](https://ntfy.sh/) URL with `--ntfy-url`\n- To configure the program when using Docker, edit `docker-compose.yml` and/or set environment variables.\n- **For further information, use `--help`**\n\n### How to uninstall \n- If you used Docker, run `docker-compose down --rmi all` in the cloned repository\n- If you used Poetry, just delete the virtual environment and then the cloned repository",
"bugtrack_url": null,
"license": "MIT",
"summary": "Detect all the things",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cf8f6bc568706acbde5104c028418a22b398fc3ddf49818584ba3b63c79e1d4f",
"md5": "a5bfde00bcd98c8172c4f72c5d014a8e",
"sha256": "b40d7d3eb18874bc96242f359fc58c7a57e64878a4ba37f8087c1afe12de3886"
},
"downloads": -1,
"filename": "set_detect_notify-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a5bfde00bcd98c8172c4f72c5d014a8e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<3.12",
"size": 22631,
"upload_time": "2023-10-21T21:33:48",
"upload_time_iso_8601": "2023-10-21T21:33:48.682291Z",
"url": "https://files.pythonhosted.org/packages/cf/8f/6bc568706acbde5104c028418a22b398fc3ddf49818584ba3b63c79e1d4f/set_detect_notify-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cfdf910a8b1a647ad35b2311468f537c8a4f899a7c4c299c4fd3c5305f3469ba",
"md5": "6a203206ed8c05b37a60f690bfb9c465",
"sha256": "7347ff08643cc9a6e13a36d515ef85bd1edd57346239c2ff7781f1a0e649a4f1"
},
"downloads": -1,
"filename": "set_detect_notify-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "6a203206ed8c05b37a60f690bfb9c465",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<3.12",
"size": 21765,
"upload_time": "2023-10-21T21:33:50",
"upload_time_iso_8601": "2023-10-21T21:33:50.585037Z",
"url": "https://files.pythonhosted.org/packages/cf/df/910a8b1a647ad35b2311468f537c8a4f899a7c4c299c4fd3c5305f3469ba/set_detect_notify-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-21 21:33:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "set-detect-notify"
}
