Initial port to CodeProject.AI

Author: ChrisMaunder

.gitignore

@@ -117,4 +117,5 @@ dmypy.json
 .DS_Store
 
 venv
-.vscode
+.vscode
+.vs

README.md

@@ -1,28 +1,21 @@
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 [![PyPI Version](https://img.shields.io/pypi/v/deepstack-python.svg)](https://pypi.org/project/deepstack-python/)
 
-# deepstack-python
-Unofficial python API for [DeepStack](https://docs.deepstack.cc). Provides classes for making requests to the object detection & face detection/recognition endpoints. Also includes some helper functions for processing the results. See the Jupyter notebooks for usage.
+# codeproject-ai-api
+A simple Python SDK for working with [CodeProject.AI Server](https://codeproject.com/ai). This SDK provides classes for making requests to the object detection & face detection/recognition endpoints, as well as helper functions for processing the results. See the Jupyter notebooks for usage.
 
-Run Deepstack with all three endpoints active (CPU mode):
-```
-docker run \
-      -e VISION-SCENE=True \
-      -e VISION-DETECTION=True \
-      -e VISION-FACE=True \
-      -v localstorage:/datastore \
-      -p 80:5000 \
-      -e API-KEY="" \
-      --name deepstack deepquestai/deepstack
-```
-Check deepstack is running using curl (from root of this repo):
-```
-curl -X POST -F image=@tests/images/test-image3.jpg 'http://localhost:5000/v1/vision/detection'
-```
-If all goes well you should see the following returned:
+This work is a direct port of Robin Cole's original [deepstack-python](https://github.com/robmarkcole/deepstack-python) project.
+
+Run CodeProject.AI Server (CPU mode):
 ```
-{"success":true,"predictions":[{"confidence":0.9998661,"label":"person","y_min":0,"x_min":258,"y_max":676,"x_max":485},{"confidence":0.9996547,"label":"person","y_min":0,"x_min":405,"y_max":652,"x_max":639},{"confidence":0.99745613,"label":"dog","y_min":311,"x_min":624,"y_max":591,"x_max":825}]}
+docker run --name CodeProject.AI-Server -d -p 32168:32168 ^
+ --mount type=bind,source=C:\ProgramData\CodeProject\AI\docker\data,target=/etc/codeproject/ai ^
+ --mount type=bind,source=C:\ProgramData\CodeProject\AI\docker\modules,target=/app/modules ^
+   codeproject/ai-server
 ```
+and ensure you have an ObjectDetection module and a Face Processing module installed.
+
+Check CodeProject.AI Server is running by opening the dashboard at http://localhost:32168
 
 ## Development
 * Create venv -> `python3.7 -m venv venv`

codeprojectai/__init__.py

@@ -0,0 +1 @@
+"""Init file for CodeProject.AI SDK."""

deepstack/core.py codeprojectai/core.pydeepstack/core.py renamed to codeprojectai/core.py

@@ -1,5 +1,5 @@
 """
-Deepstack core.
+CodeProject.AI SDK core.
 """
 import requests
 from PIL import Image
@@ -8,28 +8,27 @@
 from requests.models import Response
 
 ## Const
-DEFAULT_API_KEY = ""
-DEFAULT_TIMEOUT = 10  # seconds
-DEFAULT_IP = "localhost"
-DEFAULT_PORT = 80
+DEFAULT_TIMEOUT        = 10  # seconds
+DEFAULT_IP             = "localhost"
+DEFAULT_PORT           = 32168
 DEFAULT_MIN_CONFIDENCE = 0.45
 
 ## HTTP codes
 HTTP_OK = 200
 BAD_URL = 404
 
 ## API urls
-URL_BASE_VISION = "http://{ip}:{port}/v1/vision"
-URL_CUSTOM = "/custom/{custom_model}"
+URL_BASE_VISION      = "http://{ip}:{port}/v1/vision"
+URL_CUSTOM           = "/custom/{custom_model}"
 URL_OBJECT_DETECTION = "/detection"
-URL_FACE_DETECTION = "/face"
-URL_FACE_REGISTER = "/face/register"
-URL_FACE_RECOGNIZE = "/face/recognize"
-URL_FACE_LIST = "/face/list"
-URL_SCENE_RECOGNIZE = "/scene"
+URL_FACE_DETECTION   = "/face"
+URL_FACE_REGISTER    = "/face/register"
+URL_FACE_RECOGNIZE   = "/face/recognize"
+URL_FACE_LIST        = "/face/list"
+# URL_SCENE_RECOGNIZE = "/scene"
 
 
-class DeepstackException(Exception):
+class CodeProjectAIException(Exception):
     pass
 
 
@@ -98,18 +97,18 @@ def get_objects_summary(predictions: List[Dict]):
 def post_image(
     url: str, image_bytes: bytes, timeout: int, data: dict
 ) -> requests.models.Response:
-    """Post an image to Deepstack. Only handles exceptions."""
+    """Post an image to CodeProject.AI Server. Only handles exceptions."""
     try:
         return requests.post(
             url, files={"image": image_bytes}, data=data, timeout=timeout
         )
     except requests.exceptions.Timeout:
-        raise DeepstackException(
-            f"Timeout connecting to Deepstack, the current timeout is {timeout} seconds, try increasing this value"
+        raise CodeProjectAIException(
+            f"Timeout connecting to CodeProject.AI Server, the current timeout is {timeout} seconds, try increasing this value"
         )
     except requests.exceptions.ConnectionError or requests.exceptions.MissingSchema as exc:
-        raise DeepstackException(
-            f"Deepstack connection error, check your IP and port: {exc}"
+        raise CodeProjectAIException(
+            f"CodeProject.AI Server connection error, check your IP and port: {exc}"
         )
 
 
@@ -128,10 +127,10 @@ def process_image(
     if response.status_code == HTTP_OK:
         return response.json()
     elif response.status_code == BAD_URL:
-        raise DeepstackException(f"Bad url supplied, url {url} raised error {BAD_URL}")
+        raise CodeProjectAIException(f"Bad url supplied, url {url} raised error {BAD_URL}")
     else:
-        raise DeepstackException(
-            f"Error from Deepstack request, status code: {response.status_code}"
+        raise CodeProjectAIException(
+            f"Error from CodeProject.AI Server request, status code: {response.status_code}"
         )
 
 
@@ -140,39 +139,37 @@ def get_stored_faces(url, api_key, timeout) -> List:
     try:
         data = requests.post(url, timeout=timeout, data={"api_key": api_key})
     except requests.exceptions.Timeout:
-        raise DeepstackException(
-            f"Timeout connecting to Deepstack, the current timeout is {timeout} seconds, try increasing this value"
+        raise CodeProjectAIException(
+            f"Timeout connecting to CodeProject.AI Server, the current timeout is {timeout} seconds, try increasing this value"
         )
     except requests.exceptions.ConnectionError or requests.exceptions.MissingSchema as exc:
-        raise DeepstackException(
-            f"Deepstack connection error, check your IP and port: {exc}"
+        raise CodeProjectAIException(
+            f"CodeProject.AI Server connection error, check your IP and port: {exc}"
         )
     return data.json()
 
 
-class DeepstackVision:
-    """Base class for Deepstack vision."""
+class CodeProjectAIVision:
+    """Base class for CodeProject.AI vision."""
 
     def __init__(
         self,
-        ip: str = DEFAULT_IP,
-        port: int = DEFAULT_PORT,
-        api_key: str = DEFAULT_API_KEY,
-        timeout: int = DEFAULT_TIMEOUT,
+        ip: str               = DEFAULT_IP,
+        port: int             = DEFAULT_PORT,
+        timeout: int          = DEFAULT_TIMEOUT,
         min_confidence: float = DEFAULT_MIN_CONFIDENCE,
-        url_detect: str = "",
-        url_recognize: str = "",
-        url_register: str = "",
-        url_face_list: str = "",
+        url_detect: str       = "",
+        url_recognize: str    = "",
+        url_register: str     = "",
+        url_face_list: str    = "",
     ):
-        self._api_key = api_key
-        self._timeout = timeout
+        self._timeout        = timeout
         self._min_confidence = min_confidence
-        self._url_base = URL_BASE_VISION.format(ip=ip, port=port)
-        self._url_detect = self._url_base + url_detect
-        self._url_recognize = self._url_base + url_recognize
-        self._url_register = self._url_base + url_register
-        self._url_face_list = self._url_base + url_face_list
+        self._url_base       = URL_BASE_VISION.format(ip=ip, port=port)
+        self._url_detect     = self._url_base + url_detect
+        self._url_recognize  = self._url_base + url_recognize
+        self._url_register   = self._url_base + url_register
+        self._url_face_list  = self._url_base + url_face_list
 
     def detect(self):
         """Process image_bytes and detect."""
@@ -187,17 +184,16 @@ def register(self):
         raise NotImplementedError
 
 
-class DeepstackObject(DeepstackVision):
+class CodeProjectAIObject(CodeProjectAIVision):
     """Work with objects"""
 
     def __init__(
         self,
-        ip: str = DEFAULT_IP,
-        port: int = DEFAULT_PORT,
-        api_key: str = DEFAULT_API_KEY,
-        timeout: int = DEFAULT_TIMEOUT,
+        ip: str               = DEFAULT_IP,
+        port: int             = DEFAULT_PORT,
+        timeout: int          = DEFAULT_TIMEOUT,
         min_confidence: float = DEFAULT_MIN_CONFIDENCE,
-        custom_model: str = "",
+        custom_model: str     = "",
     ):
         if custom_model:
             url_detect = URL_CUSTOM.format(custom_model=custom_model)
@@ -206,7 +202,6 @@ def __init__(
         super().__init__(
             ip=ip,
             port=port,
-            api_key=api_key,
             timeout=timeout,
             min_confidence=min_confidence,
             url_detect=url_detect,
@@ -215,17 +210,17 @@ def __init__(
     def detect(self, image_bytes: bytes):
         """Process image_bytes and detect."""
         response = process_image(
-            url=self._url_detect,
-            image_bytes=image_bytes,
-            api_key=self._api_key,
-            min_confidence=self._min_confidence,
-            timeout=self._timeout,
+            url            = self._url_detect,
+            image_bytes    = image_bytes,
+            api_key        = self._api_key,
+            min_confidence = self._min_confidence,
+            timeout        = self._timeout,
         )
         return response["predictions"]
 
-
-class DeepstackScene(DeepstackVision):
-    """Work with scenes"""
+"""
+class CodeProjectAIScene(CodeProjectAIVision):
+    # Work with scenes
 
     def __init__(
         self,
@@ -245,7 +240,7 @@ def __init__(
         )
 
     def recognize(self, image_bytes: bytes):
-        """Process image_bytes and detect."""
+        #Process image_bytes and detect.
         response = process_image(
             url=self._url_recognize,
             image_bytes=image_bytes,
@@ -255,39 +250,37 @@ def recognize(self, image_bytes: bytes):
         )
         del response["success"]
         return response
+"""
 
-
-class DeepstackFace(DeepstackVision):
+class CodeProjectAIFace(CodeProjectAIVision):
     """Work with objects"""
 
     def __init__(
         self,
-        ip: str = DEFAULT_IP,
-        port: int = DEFAULT_PORT,
-        api_key: str = DEFAULT_API_KEY,
-        timeout: int = DEFAULT_TIMEOUT,
+        ip: str               = DEFAULT_IP,
+        port: int             = DEFAULT_PORT,
+        timeout: int          = DEFAULT_TIMEOUT,
         min_confidence: float = DEFAULT_MIN_CONFIDENCE,
     ):
         super().__init__(
-            ip=ip,
-            port=port,
-            api_key=api_key,
-            timeout=timeout,
-            min_confidence=min_confidence,
-            url_detect=URL_FACE_DETECTION,
-            url_register=URL_FACE_REGISTER,
-            url_recognize=URL_FACE_RECOGNIZE,
-            url_face_list=URL_FACE_LIST,
+            ip             = ip,
+            port           = port,
+            timeout        = timeout,
+            min_confidence = min_confidence,
+            url_detect     = URL_FACE_DETECTION,
+            url_register   = URL_FACE_REGISTER,
+            url_recognize  = URL_FACE_RECOGNIZE,
+            url_face_list  = URL_FACE_LIST,
         )
 
     def detect(self, image_bytes: bytes):
         """Process image_bytes and detect."""
         response = process_image(
-            url=self._url_detect,
-            image_bytes=image_bytes,
-            api_key=self._api_key,
-            min_confidence=self._min_confidence,
-            timeout=self._timeout,
+            url            = self._url_detect,
+            image_bytes    = image_bytes,
+            api_key        = self._api_key,
+            min_confidence = self._min_confidence,
+            timeout        = self._timeout,
         )
         return response["predictions"]
 
@@ -296,31 +289,31 @@ def register(self, name: str, image_bytes: bytes):
         Register a face name to a file.
         """
         response = process_image(
-            url=self._url_register,
-            image_bytes=image_bytes,
-            api_key=self._api_key,
-            min_confidence=self._min_confidence,
-            timeout=self._timeout,
-            data={"userid": name},
+            url            = self._url_register,
+            image_bytes    = image_bytes,
+            api_key        = self._api_key,
+            min_confidence = self._min_confidence,
+            timeout        = self._timeout,
+            data           = { "userid": name },
         )
 
         if response["success"] == True:
             return response["message"]
 
         elif response["success"] == False:
             error = response["error"]
-            raise DeepstackException(
-                f"Deepstack raised an error registering a face: {error}"
+            raise CodeProjectAIException(
+                f"CodeProject.AI Server raised an error registering a face: {error}"
             )
 
     def recognize(self, image_bytes: bytes):
         """Process image_bytes, performing recognition."""
         response = process_image(
-            url=self._url_recognize,
-            image_bytes=image_bytes,
-            api_key=self._api_key,
-            min_confidence=self._min_confidence,
-            timeout=self._timeout,
+            url            = self._url_recognize,
+            image_bytes    = image_bytes,
+            api_key        = self._api_key,
+            min_confidence = self._min_confidence,
+            timeout        = self._timeout,
         )
 
         return response["predictions"]

deepstack/__init__.py

@@ -1,21 +1,21 @@
 from setuptools import setup, find_packages
 
-VERSION = "0.9"
+VERSION = "0.1"
 
 REQUIRES = ["requests"]
 
 setup(
-    name="deepstack-python",
-    version=VERSION,
-    url="https://github.com/robmarkcole/deepstack-python",
-    author="Robin Cole",
-    author_email="robmarkcole@gmail.com",
-    description="Unofficial python API for DeepStack",
-    install_requires=REQUIRES,
-    packages=find_packages(),
-    license="Apache License, Version 2.0",
-    python_requires=">=3.7",
-    classifiers=[
+    name             = "codeproject-ai-api",
+    version          = VERSION,
+    url              = "https://github.com/codeproject/codeproject-ai-api",
+    author           = "CodeProject",
+    author_email     = "info@codeproject.com",
+    description      = "Provides a simple SDK for the CodeProject.AI Server API",
+    install_requires = REQUIRES,
+    packages         = find_packages(),
+    license          = "Apache License, Version 2.0",
+    python_requires  = ">=3.7",
+    classifiers      = [
         "Intended Audience :: Developers",
         "Natural Language :: English",
         "Programming Language :: Python",