An open API service indexing awesome lists of open source software.

https://github.com/wajktor13/security-camera

GUI app that turns any camera into surveillance camera
https://github.com/wajktor13/security-camera

agh agh-university agh-wi agh-wiet gmail-api google-drive-api opencv opencv-python python python3 tkinter

Last synced: 7 months ago
JSON representation

GUI app that turns any camera into surveillance camera

Awesome Lists containing this project

README

          





Logo

Security Camera


GUI app that turns any camera into useful surveillance camera


Report Bug or Request Feature


Table of Contents



  1. About The Project



  2. Getting Started


  3. Usage

  4. Roadmap

  5. Contributing

  6. License

  7. Contact

  8. Acknowledgments

## About The Project

![image (3)](https://github.com/Wajktor13/security-camera/assets/76243064/362724ac-29b6-4114-ade6-fe8a6125939d)

Security Camera is an easy to use GUI app that provides functionalities similar to typical software of a surveillance camera (or even more!).
Some of the currently available features:
* neat GUI
* continuous and emergency recording
* motion detection
* buffer for emergency recordings
* system and email notifications
* uploading recordings to google drive
* various recording and preview modes
* saving settings to JSON
* debug log
* adjustable parameters (check usage)

The project came to life as a final assignment for a Python Course at the AGH University. It was created in collaboration with [@Xavvee](https://github.com/Xavvee).

(back to top)

### Built With

[![Python](https://img.shields.io/static/v1?style=for-the-badge&message=Python&color=3776AB&logo=Python&logoColor=FFFFFF&label=)](https://www.python.org/)
[![OpenCV](https://img.shields.io/static/v1?style=for-the-badge&message=OpenCV&color=5C3EE8&logo=OpenCV&logoColor=FFFFFF&label=)](https://opencv.org/)
[![Google Drive](https://img.shields.io/static/v1?style=for-the-badge&message=Google+Drive+API&color=4285F4&logo=Google+Drive&logoColor=FFFFFF&label=)](https://drive.google.com)
[![Gmail](https://img.shields.io/static/v1?style=for-the-badge&message=Gmail+API&color=EA4335&logo=Gmail&logoColor=FFFFFF&label=)](https://mail.google.com)

(back to top)

## Getting Started
### Prerequisites

* Python 3 (preferably >= 3.10)
* git

### Installation

1. Clone the repo (or download the latest release)
```sh
git clone https://github.com/Wajktor13/security-camera
```
2. Enter **_security-camera_** directory and install python libraries with pip
```sh
pip install -r requirements.txt
```
3. Enter **_security-camera/src_** directory and run **_run.py_** with Python
```sh
python run.py
```
### API

If you want to use email notifications and uploading to Google Drive, you need your own API keys.




_tutorial coming soon_

(back to top)

## Usage

![image (4)](https://github.com/Wajktor13/security-camera/assets/76243064/66693563-27b8-47be-8d27-76a6d6b6a6f6)
![image (1)](https://github.com/Wajktor13/security-camera/assets/76243064/0a56457b-22df-4196-961a-e30407f7b273)
![image (2)](https://github.com/Wajktor13/security-camera/assets/76243064/b96aef6d-64b2-4f77-96a8-1fe9ad655319)

(back to top)

## Roadmap

TODO:
- [ ] stats
- [ ] low resources consumption mode
- [ ] recording schedule

See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).

(back to top)

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

(back to top)

## License

Distributed under the Apache License 2.0. See [LICENSE](https://github.com/Wajktor13/security-camera/blob/main/LICENSE) for more information.

(back to top)

## Contact

Wiktor Wilkusz - wiktorwilkusz13@gmail.com

Project link: https://github.com/Wajktor13/security-camera

(back to top)

## Acknowledgments
* [Python](https://www.python.org/)
* [OpenCV](https://opencv.org/)
* [custom tkinter theme](https://github.com/rdbende/Forest-ttk-theme)

(back to top)