Updated project structure and some file names.

Restored `requirements.txt`

Updated `setup.py` to include new repository url and contact details.

Moved the rtsp code from `record` to `stream`.

Updated project structure to make it more readable and developer friendly - moved mixins to the `mixins` package, moved handlers to the `handlers` package.

Moved files not belonging to anything in particular to the `util` package.

Updated `camera` class to also defer login call.

Deleted unused files like `config_handler`.

Author: Benehiko

README.md

@@ -2,9 +2,9 @@
 
 <p align="center">
  <img alt="Reolink Approval" src="https://img.shields.io/badge/reolink-approved-blue?style=flat-square">
- <img alt="GitHub" src="https://img.shields.io/github/license/ReolinkCameraApi/reolink-python-api?style=flat-square">
- <img alt="GitHub tag (latest SemVer)" src="https://img.shields.io/github/v/tag/ReolinkCameraApi/reolink-python-api?style=flat-square">
- <img alt="PyPI" src="https://img.shields.io/pypi/v/reolink-api?style=flat-square">
+ <img alt="GitHub" src="https://img.shields.io/github/license/ReolinkCameraAPI/reolinkapipy?style=flat-square">
+ <img alt="GitHub tag (latest SemVer)" src="https://img.shields.io/github/v/tag/ReolinkCameraAPI/reolinkapipy?style=flat-square">
+ <img alt="PyPI" src="https://img.shields.io/pypi/v/reolinkapi?style=flat-square">
  <img alt="Discord" src="https://img.shields.io/discord/773257004911034389?style=flat-square">
 </p>
 

examples/basic_usage.py

@@ -0,0 +1,11 @@
+import reolinkapi
+
+if __name__ == "__main__":
+    cam = reolinkapi.Camera("192.168.0.102", defer_login=True)
+
+    # must first login since I defer have deferred the login process
+    cam.login()
+
+    dst = cam.get_dst()
+    ok = cam.add_user("foo", "bar", "admin")
+    alarm = cam.get_alarm_motion()

reolinkapi/__init__.py

@@ -1,4 +1,4 @@
-from .api_handler import APIHandler
+from reolinkapi.handlers.api_handler import APIHandler
 from .camera import Camera
 
 __version__ = "0.1.2"

reolinkapi/camera.py

@@ -1,24 +1,38 @@
-from .api_handler import APIHandler
+from reolinkapi.handlers.api_handler import APIHandler
 
 
 class Camera(APIHandler):
 
-    def __init__(self, ip: str, username: str = "admin", password: str = "", https: bool = False):
+    def __init__(self, ip: str,
+                 username: str = "admin",
+                 password: str = "",
+                 https: bool = False,
+                 defer_login: bool = False,
+                 **kwargs):
         """
         Initialise the Camera object by passing the ip address.
         The default details {"username":"admin", "password":""} will be used if nothing passed
+        For deferring the login to the camera, just pass defer_login = True.
+        For connecting to the camera behind a proxy pass a proxy argument: proxy={"http": "socks5://127.0.0.1:8000"}
         :param ip:
         :param username:
         :param password:
+        :param https: connect to the camera over https
+        :param defer_login: defer the login process
+        :param proxy: Add a proxy dict for requests to consume.
+        eg: {"http":"socks5://[username]:[password]@[host]:[port], "https": ...}
+        More information on proxies in requests: https://stackoverflow.com/a/15661226/9313679
         """
         # For when you need to connect to a camera behind a proxy, pass
         # a proxy argument: proxy={"http": "socks5://127.0.0.1:8000"}
-        APIHandler.__init__(self, ip, username, password, https=https)
+        APIHandler.__init__(self, ip, username, password, https=https, **kwargs)
 
         # Normal call without proxy:
         # APIHandler.__init__(self, ip, username, password)
 
         self.ip = ip
         self.username = username
         self.password = password
-        super().login()
+
+        if not defer_login:
+            super().login()

reolinkapi/config_handler.py

@@ -1,18 +1,19 @@
 import requests
 from typing import Dict, List, Optional, Union
-from reolinkapi.alarm import AlarmAPIMixin
-from reolinkapi.device import DeviceAPIMixin
-from reolinkapi.display import DisplayAPIMixin
-from reolinkapi.download import DownloadAPIMixin
-from reolinkapi.image import ImageAPIMixin
-from reolinkapi.motion import MotionAPIMixin
-from reolinkapi.network import NetworkAPIMixin
-from reolinkapi.ptz import PtzAPIMixin
-from reolinkapi.recording import RecordingAPIMixin
-from reolinkapi.resthandle import Request
-from reolinkapi.system import SystemAPIMixin
-from reolinkapi.user import UserAPIMixin
-from reolinkapi.zoom import ZoomAPIMixin
+from reolinkapi.mixins.alarm import AlarmAPIMixin
+from reolinkapi.mixins.device import DeviceAPIMixin
+from reolinkapi.mixins.display import DisplayAPIMixin
+from reolinkapi.mixins.download import DownloadAPIMixin
+from reolinkapi.mixins.image import ImageAPIMixin
+from reolinkapi.mixins.motion import MotionAPIMixin
+from reolinkapi.mixins.network import NetworkAPIMixin
+from reolinkapi.mixins.ptz import PtzAPIMixin
+from reolinkapi.mixins.record import RecordAPIMixin
+from reolinkapi.handlers.rest_handler import Request
+from reolinkapi.mixins.stream import StreamAPIMixin
+from reolinkapi.mixins.system import SystemAPIMixin
+from reolinkapi.mixins.user import UserAPIMixin
+from reolinkapi.mixins.zoom import ZoomAPIMixin
 
 
 class APIHandler(AlarmAPIMixin,
@@ -23,10 +24,11 @@ class APIHandler(AlarmAPIMixin,
                  MotionAPIMixin,
                  NetworkAPIMixin,
                  PtzAPIMixin,
-                 RecordingAPIMixin,
+                 RecordAPIMixin,
                  SystemAPIMixin,
                  UserAPIMixin,
-                 ZoomAPIMixin):
+                 ZoomAPIMixin,
+                 StreamAPIMixin):
     """
     The APIHandler class is the backend part of the API, the actual API calls
     are implemented in Mixins.
@@ -42,6 +44,7 @@ def __init__(self, ip: str, username: str, password: str, https: bool = False, *
         :param ip:
         :param username:
         :param password:
+        :param https: connect over https
         :param proxy: Add a proxy dict for requests to consume.
         eg: {"http":"socks5://[username]:[password]@[host]:[port], "https": ...}
         More information on proxies in requests: https://stackoverflow.com/a/15661226/9313679