Merge pull request #5 from drucker/feature/pipnize-drucker-client

Merged

Author: keigohtr

.gitignore

@@ -103,9 +103,8 @@ ENV/
 # PyCharm
 .idea/
 
-# grpc file
-drucker_pb2.py
-drucker_pb2_grpc.py
-
 # Mac OS temporary file
-.DS_Store
+.DS_Store
+
+# sqlite
+*.sqlite3

.gitmodules

@@ -1,4 +1,4 @@
-[submodule "drucker-grpc-proto"]
-	path = drucker-grpc-proto
+[submodule "drucker_client/grpc"]
+	path = drucker_client/grpc
 	url = https://github.com/drucker/drucker-grpc-proto.git
 	branch = master

.travis.yml

@@ -0,0 +1,23 @@
+# ref: https://docs.travis-ci.com/user/languages/python
+language: python
+dist: trusty
+sudo: true
+services:
+- docker
+
+matrix:
+  include:
+  - python: 3.4
+    env: TOXENV=py34
+  - python: 3.5
+    env: TOXENV=py35
+  - python: 3.6
+    env: TOXENV=py36
+  - python: 3.6
+    env: TOXENV=coverage,codecov
+
+install:
+- pip install tox
+
+script:
+- tox

README.md

@@ -1,5 +1,5 @@
 # drucker-client
-Drucker is a framework of serving machine learning module. Drucker makes it easy to serve, manage and integrate your ML models into your existing services. Moreover, Drucker can be used on Kubernetes. This project is a SDK for accessing Drucker service of your ML module. All you need is initializing ```DruckerWorkerClient``` class.
+Drucker is a framework of serving machine learning module. Drucker client is a SDK for accessing Drucker.
 
 ## Parent Project
 https://github.com/drucker/drucker-parent
@@ -10,6 +10,64 @@ https://github.com/drucker/drucker-parent
 - [Drucker-client](https://github.com/drucker/drucker-client) (here): SDK for accessing a drucker service.
 - [Drucker-example](https://github.com/drucker/drucker-example): Example of how to use drucker.
 
+## Installation
+From source:
+
+```
+git clone --recursive https://github.com/drucker/drucker-client.git
+cd drucker-client
+python setup.py install
+```
+
+From [PyPi](https://pypi.org/project/drucker_client/) directly:
+
+```
+pip install drucker_client
+```
+
+## Example
+Example is available [here](example/sample.py).
+
+```python
+from drucker_client import DruckerWorkerClient
+from drucker_client.logger import logger
+
+
+host = 'localhost:5000'
+client = DruckerWorkerClient(logger=logger, host=host)
+
+input = [0,0,0,1,11,0,0,0,0,0,
+         0,7,8,0,0,0,0,0,1,13,
+         6,2,2,0,0,0,7,15,0,9,
+         8,0,0,5,16,10,0,16,6,0,
+         0,4,15,16,13,16,1,0,0,0,
+         0,3,15,10,0,0,0,0,0,2,
+         16,4,0,0]
+response = client.run_predict_arrint_arrint(input)
+```
+
+If you want to access the Drucker which runs on Kubernetes, try it below.
+
+```python
+from drucker_client import DruckerWorkerClient
+from drucker_client.logger import logger
+
+
+domain = 'example.com'
+app = 'drucker-sample'
+env = 'development'
+client = DruckerWorkerClient(logger=logger, domain=domain, app=app, env=env)
+
+input = [0,0,0,1,11,0,0,0,0,0,
+         0,7,8,0,0,0,0,0,1,13,
+         6,2,2,0,0,0,7,15,0,9,
+         8,0,0,5,16,10,0,16,6,0,
+         0,4,15,16,13,16,1,0,0,0,
+         0,3,15,10,0,0,0,0,0,2,
+         16,4,0,0]
+response = client.run_predict_arrint_arrint(input)
+```
+
 ### Available methods of ```DruckerWorkerClient```
 You need to use an appropriate method for your Drucker service. The methods are generated according to the input and output formats. *V* is the length of feature vector. *M* is the number of classes. If your algorithm is a binary classifier, you set *M* to 1. If your algorithm is a multi-class classifier, you set *M* to the number of classes.
 
@@ -47,10 +105,7 @@ The input "option" field needs to be a json format. Any style is Ok but we have
 |:---|:---|:---|
 |suppress_log_input |bool |True: NOT print the input and output to the log message. <BR>False (default): Print the input and output to the log message.
 
-### Run it
+### Test
 ```
-$ sh start.sh
+python -m unittest drucker_client/test/test_worker_client.py
 ```
-
-## Drucker on Kubernetes
-https://github.com/drucker/drucker-parent/tree/master/docs/Installation.md

__init__.py

@@ -0,0 +1,18 @@
+# Copyright 2018 The Drucker Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+__project__ = 'drucker_client'
+__version__ = "0.4.0"
+
+from .drucker_worker_client import DruckerWorkerClient

core/__init__.py

@@ -1,16 +1,13 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
-#
-# DO NOT EDIT HERE!!
+
 
 import traceback
 import types
 import grpc
 
-import drucker_pb2
-import drucker_pb2_grpc
-
-from logger.logger_interface import SystemLoggerInterface
+from .protobuf import drucker_pb2, drucker_pb2_grpc
+from .logger import SystemLoggerInterface
 
 
 def error_handling(error_response):
@@ -42,9 +39,10 @@ def _wrapper(*args, **kwargs):
 
 
 class DruckerWorkerClient:
-    def __init__(self, logger:SystemLoggerInterface,
-                 host:str=None,
-                 domain:str=None, app:str=None, env:str=None, version:int=None):
+    def __init__(self, logger: SystemLoggerInterface,
+                 host: str = None,
+                 domain: str = None, app: str = None,
+                 env: str = None, version: int = None):
         self.logger = logger
         self.stub = None
         if host is None and (domain is None or app is None or env is None):
@@ -73,11 +71,11 @@ def on_error(self, error: Exception):
         self.logger.error(str(error))
         self.logger.error(traceback.format_exc())
 
-    def __change_domain_app_env(self, domain:str, app:str, env:str, version:str):
+    def __change_domain_app_env(self, domain: str, app: str, env: str, version: str):
         host = "{0}-{1}-{2}.{3}".format(app,version,env,domain)
         self.__change_host(host)
 
-    def __change_host(self, host:str):
+    def __change_host(self, host: str):
         channel = grpc.insecure_channel(host)
         self.stub = drucker_pb2_grpc.DruckerWorkerStub(channel)