Skip to content

Latest commit

 

History

History
188 lines (127 loc) · 5.61 KB

README.md

File metadata and controls

188 lines (127 loc) · 5.61 KB
Raw


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)

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.

(back to top)

Built With

Python OpenCV Google Drive Gmail

(back to top)

Getting Started

Prerequisites

  • Python 3 (preferably >= 3.10)
  • git

Installation

  1. Clone the repo (or download the latest release) 
       git clone https://github.com/Wajktor13/security-camera
  2. Enter security-camera directory and install python libraries with pip 
       pip install -r requirements.txt
  3. Enter security-camera/src directory and run run.py with Python 
       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) image (1) image (2)

(back to top)

Roadmap

TODO:

  • stats
  • low resources consumption mode
  • recording schedule

See the open 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 for more information.

(back to top)

Contact

Wiktor Wilkusz - [email protected]

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

(back to top)

Acknowledgments

(back to top)