Initial Commit

Author: NickChecan

.gitignore

@@ -0,0 +1,8 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+
+# Environments
+venv/
+
+# PyCharm IDE
+.idea/

README.md

@@ -0,0 +1,116 @@
+
+Hana to Python Application
+===================
+
+The purpose of this project is to implement a simple Python application to demonstrate the integration between a common third party application to a SAP Hana database.
+
+> **Note:**
+> 
+> - This project is directly linked to  the project at the [HanaService](https://github.com/NickChecan/HanaService) repository.
+> - Project developed with Python 3.7.
+
+
+----------
+
+Project Components
+-------------
+
+This project uses the [Flask](http://flask.pocoo.org/) framework to serve data through a simple web site platform locally. 
+
+```
+HanaToPython-Application
+	├── app
+	│    ├── modules
+	│    │    ├── Controller.py
+	│    │    ├── Model.py
+	│    │    └── __init__.py
+	│    ├── templates
+	│    │    └── index.html
+	│    └── __init__.py
+	├── config.py
+	├── requirements.txt
+	└── run.py
+```
+
+The routes used in this application can be found at **./app/modules/Controller.py**.
+
+The **.app/modules/Model.py** file will be responsible to access the Hana data through a database connection established by the information provided at the **config.py** file.
+
+The template folder will handle all views available for the application.
+
+The file **requirements.txt** contains all the plugins used for the current application and the **run.py** file will be responsible for the application execution.
+
+
+----------
+
+Getting Started
+-------------
+
+Before importing this project to your Python workspace, it is necessary to make sure the prerequisites steps are properly done in your development environment.
+The installation procedure described in this documentation will assume you've already have Python installed at your computer.
+
+#### <i class="icon-layers"></i> Prerequisites
+
+ - Hana Service </br>
+ To execute this application it will be necessary to properly deploy the [Hana Service](https://github.com/NickChecan/HanaService) project into your Hana Trial environment.
+
+ - A Python Editor of your choice </br>
+ For this project the [PyCharm](https://www.jetbrains.com/pycharm/) IDE and [Visual Studio Code](https://code.visualstudio.com/) was used for development, but the same is not required to correctly deploy the application it self.
+
+ - Install the virtual environment package </br>
+ **Virtual Environment** (virtualenv) is a tool to create isolated Python environments. The *virtualenv* command creates a folder which contains all the necessary executables to use the packages that a Python project would need. The same can be installed as described in [this link](http://docs.python-guide.org/en/latest/dev/virtualenvs/) through the following command:
+
+```
+$ pip install virtualenv
+```
+
+
+#### <i class="icon-download"></i> Installing
+
+The steps bellow will guide you through the project installation.  </br>
+The following commands should be executed in your computer console at the project folder:
+
+* Clone the project to your local repository workspace;
+
+* Create a virtual environment for the imported application through the following command:
+```
+$ virtualenv <Virtual Environment name>
+```
+* Activate your virtual environment with the command:
+```
+$ <Virtual Environment name>\Scripts\activate
+```
+ * With the virtual environment properly activated, install the plugins available at the **requirements.txt** file through the command:
+```
+$ pip install -r requirements.txt
+```
+This process should enable your application to be deployed in a local server for test purpose.
+
+
+> **Note:**
+> 
+> - With the [Hana Service](https://github.com/NickChecan/HanaService) properly deployed, the **config.py** file should be modified to attend the address of your Hana Trial Instance.
+
+
+----------
+
+Deployment
+-------------
+
+With the Hana Service properly deployed, the **config.py** file modified to attend your Hana Trial Instance and the virtual environment activated, the python application should run through the following command:
+
+```
+$ python run.py
+```
+
+The same will enable the project to be accessed by you web browser trough a URL displayed by the mentioned command execution.
+
+> **Tips:**
+> 
+> - As mentioned in the Hana Service project repository, always remember to make sure the Hana Trial Instance is up and running through the Cloud Platform Cockpit before execute commands or test any application directly linked to the Hana Service.
+
+
+
+Acknowledgments
+-------------
+This project was made possible thanks to the Flask framework tutorials available at the [Tutorials Point](https://www.tutorialspoint.com/flask/) and at [Bruno Rocha](http://brunorocha.org/) personal blog. These two web sites was incredibly helpful in the development and preparation step of this project.

app/__init__.py

@@ -0,0 +1 @@
+

app/modules/Controller.py

@@ -0,0 +1,22 @@
+import json
+from flask import Blueprint
+from app.modules.Model import Model
+
+model = Model()
+controller = Blueprint('controller', "HanaToPython")
+
+
+@controller.route("/api/getRegions")
+def get_regions():
+    return json.dumps(model.get_regions), 200, {"Content-Type": "application/json"}
+
+
+@controller.route("/api/getProducts")
+def get_products():
+    return json.dumps(model.get_products), 200, {"Content-Type": "application/json"}
+
+
+@controller.route("/api/getSalesData")
+def get_sales_data():
+    return json.dumps(model.get_sales_data), 200, {"Content-Type": "application/json"}
+

app/modules/Model.py

@@ -0,0 +1,46 @@
+import pyhdb
+from config import Hana
+
+
+class Model(object):
+
+    connection = None
+
+    def __init__(self):
+        self.connection = pyhdb.connect(Hana.HOST, Hana.PORT, Hana.USER, Hana.PASS)
+
+    @property
+    def get_regions(self):
+        regions_data = []
+        cursor = self.connection.cursor()
+        cursor.execute("SELECT * FROM \"SALES_TUTORIAL\".\"HanaService.CDSScripts::SalesDDL.Region\"")
+        result_set = cursor.fetchall()
+        for result in result_set:
+            regions_data.append({"regionId": result[0],
+                                 "regionName": result[1],
+                                 "subRegionName": str(result[2])})
+        return regions_data
+
+    @property
+    def get_products(self):
+        products_data = []
+        cursor = self.connection.cursor()
+        cursor.execute("SELECT * FROM \"SALES_TUTORIAL\".\"HanaService.CDSScripts::SalesDDL.Product\"")
+        result_set = cursor.fetchall()
+        for result in result_set:
+            products_data.append({"productId": result[0],
+                                  "productName": result[1]})
+        return products_data
+
+    @property
+    def get_sales_data(self):
+        sales_data = []
+        cursor = self.connection.cursor()
+        cursor.execute("SELECT * FROM \"_SYS_BIC\".\"HanaService/SalesData\"")
+        result_set = cursor.fetchall()
+        for result in result_set:
+            sales_data.append({"regionName": result[0],
+                               "productName": result[1],
+                               "salesAmount": str(result[2])})
+        return sales_data
+

app/modules/__init__.py

@@ -0,0 +1,44 @@
+<!DOCTYPE html>
+<html lang="pt-br">
+	<head>
+    	<meta charset="utf-8">
+    	<title>Hana 2 Python</title>
+    	<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
+    	<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+    	<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
+    	<script>
+        	$(document).ready(function () {
+        		
+        		$.get("api/getSalesData", function (data) {
+        			console.log(data);
+        			for(var i = 0; i < data.length; i++) {
+        				$("#table tbody").append('<tr><td>' + data[i].regionName + 
+        										 '</td><td>' + data[i].productName + 
+        										 '</td><td>' + data[i].salesAmount + '</td>');	
+        			}
+				}, "json");
+
+				var link1 = "http://" + window.location.host + "/api/getRegions";
+        		$("#link1").attr("href", link1).text(link1);
+        		var link2 = "http://" + window.location.host + "/api/getProducts";
+        		$("#link2").attr("href", link2).text(link2);
+
+	        });
+    	</script>
+   		<div class="container">
+   			<h2>Hana data in a Python web application</h2>
+   			<p>This application uses common python/web frameworks. Gathering sales informations...</p>
+   			<table id="table" class="table table-striped">
+    			<thead>
+      				<tr>
+	        			<th>Region Name</th>
+    	    			<th>Product Name</th>
+    	    			<th>Sales Amount</th>
+      				</tr>
+    			</thead>
+    			<tbody></tbody>
+  			</table>
+            <p>Try also <a id="link1"></a> or <a id="link2"></a>.</p>
+   		</div>
+	</body>
+</html>

app/templates/index.html

@@ -0,0 +1,10 @@
+class DevelopmentConfig(object):
+    DEBUG = True
+    TESTING = False
+
+
+class Hana(object):
+    HOST = "localhost"
+    PORT = "00000"
+    USER = "SYSTEM"
+    PASS = "XXXXXX"

config.py

@@ -0,0 +1,7 @@
+click==6.7
+Flask==0.12.2
+itsdangerous==0.24
+Jinja2==2.9.6
+MarkupSafe==1.0
+pyhdb==0.3.3
+Werkzeug==0.12.2

requirements.txt

@@ -0,0 +1,14 @@
+from flask import Flask, render_template
+from app.modules.Controller import controller
+
+app = Flask("HanaToPython", template_folder='app/templates', instance_relative_config=True)
+app.register_blueprint(controller)
+app.config.from_object('config.DevelopmentConfig')
+
+
+@app.route("/")
+def home():
+    return render_template('index.html')
+
+if __name__ == '__main__':
+    app.run(use_reloader=True)