Merged in BEDGE-2726-make-pip-installable-version- (pull request #2)

BEDGE-2726 make pip installable version

Approved-by: Sanjay K V <[email protected]>

Author: Krishna Tripathi

.gitignore

@@ -65,4 +65,4 @@ target/
 *.ini
 
 #JSONFiles
-*.json
+*.json

MANIFEST.in

@@ -0,0 +1,5 @@
+include requirements
+include README.md
+include modbus_simulator/assets/*.png
+include modbus_simulator/assets/*.ico
+include modbus_simulator/templates/*.kv

README.md

@@ -26,7 +26,14 @@ Modbus Simulator with GUI based on modbus-tk
 
 ## Running/Testing application
     $ ./tools/launcher
-    
+
+    or
+
+    With Pip
+
+    $ pip install modbus_simulator --extra-index-url http://pip.riptidieo.com/simple --trusted-host pip.riptideio.com
+    $ modubus.simu
+    `
 A GUi should show up if all the requirements are met !!
 
 ![Screen Shot 2015-11-01 at 7.25.50 PM.png](https://bitbucket.org/repo/X9byrq/images/4179375251-Screen%20Shot%202015-11-01%20at%207.25.50%20PM.png)

modbus_simulator/__init__.py

@@ -12,15 +12,18 @@
 from kivy.uix.settings import SettingsWithSidebar
 from kivy.uix.listview import ListView, ListItemButton
 from kivy.adapters.listadapter import ListAdapter
-from utils.modbus import ModbusSimu, BLOCK_TYPES, configure_modbus_logger
-from ui.settings import SettingIntegerWithRange
-from utils.backgroundJob import BackgroundJob
+from modbus_simulator.utils.modbus import ModbusSimu, BLOCK_TYPES, \
+    configure_modbus_logger
+from modbus_simulator.ui.settings import SettingIntegerWithRange
+from modbus_simulator.utils.backgroundJob import BackgroundJob
 import re
 import os
 from json import load, dump
 from kivy.config import Config
 from kivy.lang import Builder
-import ui.datamodel
+import modbus_simulator.ui.datamodel
+from pkg_resources import resource_filename
+
 
 MAP = {
     "coils": "coils",
@@ -29,9 +32,12 @@
     'holding registers': 'holding_registers'
 }
 
-SLAVES_FILE = 'slaves.json'
+settings_icon = resource_filename(__name__, "assets/Control-Panel.png")
+app_icon = resource_filename(__name__, "assets/riptideLogo.png")
+modbus_template = resource_filename(__name__, "templates/modbussimu.kv")
+Builder.load_file(modbus_template)
 
-Builder.load_file("templates/modbussimu.kv")
+SLAVES_FILE = resource_filename(__name__, "slaves.json")
 
 
 class FloatInput(TextInput):
@@ -91,6 +97,9 @@ class Gui(BoxLayout):
     data_model_input_registers = ObjectProperty()
     data_model_holding_registers = ObjectProperty()
 
+    settings = ObjectProperty()
+    riptide_logo = ObjectProperty()
+
     reset_sim_btn = ObjectProperty()
 
     # Helpers
@@ -114,6 +123,8 @@ class Gui(BoxLayout):
     def __init__(self, **kwargs):
         super(Gui, self).__init__(**kwargs)
         time_interval = kwargs.get("time_interval", 1)
+        self.settings.icon = settings_icon
+        self.riptide_logo.app_icon = app_icon
         self.config = Config.get_configparser('app')
         self.slave_list.adapter.bind(on_selection_change=self.select_slave)
         self.data_model_loc.disabled = True
@@ -1042,5 +1053,9 @@ def close_settings(self, *args):
         super(ModbusSimuApp, self).close_settings()
 
 
-if __name__ == "__main__":
+def run():
     ModbusSimuApp().run()
+
+
+if __name__ == "__main__":
+    run()

assets/Control-Panel.png renamed to modbus_simulator/assets/Control-Panel.png

@@ -2,6 +2,7 @@
 #:import KivyLexer kivy.extras.highlight.KivyLexer
 #:import ListItemButton kivy.uix.listview.ListItemButton
 #:import sla kivy.adapters.listadapter
+
 <Separator@Widget>
     size_hint_y: None
     thickness: 2
@@ -41,7 +42,10 @@
     slave_start_add: slave_start_add
     slave_end_add: slave_end_add
     action_bar: action_bar
+    settings: settings
+    riptide_logo: riptide_logo
     reset_sim_btn: reset_simulation
+
     BoxLayout:
         padding: '2sp'
         canvas:
@@ -291,8 +295,8 @@
         ActionView:
             use_separator: True
             ActionPrevious:
+                id: riptide_logo
                 with_previous: False
-                app_icon: 'assets/riptideLogo.png'
                 disabled: True
             ActionOverflow:
             ActionButton:
@@ -303,8 +307,8 @@
                 text: 'Simulate'
                 on_release: root.start_stop_simulation(*args)
             ActionButton:
+                id: settings
                 text: 'settings'
-                icon: 'assets/Control-Panel.png'
                 on_release: app.show_settings(*args)
 
 

assets/favicon.ico renamed to modbus_simulator/assets/favicon.ico

@@ -13,9 +13,11 @@
 from kivy.uix.popup import Popup
 from kivy.uix.textinput import TextInput
 
-from utils.backgroundJob import BackgroundJob
+from modbus_simulator.utils.backgroundJob import BackgroundJob
+from pkg_resources import resource_filename
 
-Builder.load_file("templates/datamodel.kv")
+datamodel_template = resource_filename(__name__, "../templates/datamodel.kv")
+Builder.load_file(datamodel_template)
 
 integers_dict = {}
 

assets/riptideLogo.png renamed to modbus_simulator/assets/riptideLogo.png

@@ -9,7 +9,7 @@
 from modbus_tk.modbus_rtu import RtuServer, RtuMaster
 from modbus_tk.modbus_tcp import TcpServer, TcpMaster
 
-from utils.common import path, make_dir, remove_file
+from modbus_simulator.utils.common import path, make_dir, remove_file
 
 ADDRESS_RANGE = {
     COILS: 0,

main.py renamed to modbus_simulator/main.py

@@ -0,0 +1,33 @@
+from setuptools import setup, find_packages
+
+
+def install_requires():
+    with open('requirements') as reqs:
+        install_req = [
+            line for line in reqs.read().split('\n')
+        ]
+    return install_req
+
+
+def readme():
+    with open("README.md") as f:
+        return f.read()
+
+
+setup(
+    name="modbus_simulator",
+    url="https://bitbucket.org/riptideio/modbus-simulator",
+    version="0.1",
+    description="Modbus Simulator using modbus_tk and kivy",
+    long_description=readme(),
+    keywords="Modbus Simulator",
+    author="riptideio",
+    packages=find_packages(),
+    install_requires=install_requires(),
+    entry_points={
+        'console_scripts': [
+            'modbus.simu = modbus_simulator.main:run',
+        ],
+    },
+    include_package_data=True
+)

templates/datamodel.kv renamed to modbus_simulator/templates/datamodel.kv

@@ -1,5 +1,8 @@
 #!/bin/bash
 
-root_dir="$(cd $(dirname $0)/..; pwd)"
-launch_cmd="$root_dir/main.py"
-python $launch_cmd
+echo $0
+root_dir="$(cd $(dirname $0)/../; pwd)"
+simu_dir="$root_dir/modbus_simulator"
+export PYTHONPATH=$root_dir
+launch_cmd="$simu_dir/main.py"
+python $launch_cmd