minor

Author: dmnfarrell

docs/source/colormaps.gif

@@ -1,11 +1,12 @@
-Code Example
-============
+Code Examples
+=============
 
-This section is for python programmers you want to use the table widget in their own programs.
+This section is for Python programmers.
 
 Basics
 ------
-Code::
+
+If you want to use the table widget in another GUI program::
 
 	python
 	from PySide2 import QtCore
@@ -37,3 +38,29 @@ Code::
 	    aw = TestApp()
 	    aw.show()
 	    app.exec_()
+
+Writing a plugin
+----------------
+
+This is quite straightforward if you are familiar with PyQt5/Pyside2. Built in plugins are kept in the plugin folder where the program is installed. You can look at these to get an idea how the plugins are written. When you make your own plugin, just add the .py file to the plugin folder under <home dir>/.config/tablexplore. It will be loaded when the program starts and added to the menu. You can add any code into the script, usually designed to execute using the table or plotter.  GUI based plugins will be added as docked widgets to the application.
+
+Here is an example plugin::
+
+	class ExamplePlugin(Plugin):
+	    """Template plugin for TableExplore"""
+
+	    #uncomment capabilities list to appear in menu
+			capabilities = ['gui']
+	    requires = ['']
+	    menuentry = 'Example Plugin'
+	    name = 'Example Plugin'
+
+	    def __init__(self, parent=None, table=None):
+	        """Customise this and/or doFrame for your widgets"""
+
+	        if parent==None:
+	            return
+	        self.parent = parent
+	        self.table = table
+	        self.createWidgets()
+	        return

docs/source/examples.rst

@@ -20,14 +20,6 @@ tablexplore.core module
    :undoc-members:
    :show-inheritance:
 
-tablexplore.data module
------------------------
-
-.. automodule:: tablexplore.data
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 tablexplore.dialogs module
 --------------------------
 

docs/source/tablexplore.rst

@@ -189,6 +189,18 @@ Rather than grouping the table directly and then plotting, it is also possible t
 Setting preferences
 -------------------
 
-Application settings are set from the Edit->Preferences menu. The image below shows the settings which are mostly self explanatory. If settings get corrupted or you want to restor defaults use the 'reset' button.
+Application settings are set from the Edit->Preferences menu. The image below shows the settings which are mostly self explanatory. If settings get corrupted or you want to restore defaults use the 'reset' button.
 
 .. image:: preferences.png
+
+Plugins
+-------
+
+Plugins can be added by anyone (see code examples on how to do this). Currently there are are only a few useful built-in plugins. New ones will be added below. To add a third party plugin (just a .py file), place it in the plugin folder under <home dir>/.config/tablexplore. For security, you shouldn't just download and run any .py file without trusting it first.
+
+Colormap plugin
++++++++++++++++
+
+This allows you to add your own colormaps for plotting. The screen grab below shows you. You can generate random colors, then edit them. When done choose the type of colormap and then save. Pick a name and this is stored and added to the list of of colormaps in the plot options. You have to restart the program to see it. (Colormaps are kept under .config/tablexplore/cmaps.pkl which can be deleted if you want to clear them.)
+
+.. image:: colormaps.gif

docs/source/usage.rst

@@ -7,7 +7,7 @@
 
 setup(
     name = 'tablexplore',
-    version = '0.6.0',
+    version = '0.5.1',
     description = 'Table analysis and plotting application written in PySide2/PyQt5',
     long_description = long_description,
     url='https://github.com/dmnfarrell/tablexplore',

setup.py

@@ -944,6 +944,7 @@ def addSheet(self, name=None, df=None, meta=None):
                 pf.hide()
 
         self.updatePlotWidgets(dfw)
+        self.updatePlugins()
         self.tabs.setCurrentIndex(idx)
         return
 
@@ -1284,7 +1285,8 @@ def discoverPlugins(self):
 
         from . import plugin
         default = os.path.join(module_path, 'plugins')
-        paths = [default]
+        other = os.path.join(core.settingspath, 'plugins')
+        paths = [default,other]
         failed = plugin.init_plugin_system(paths)
         self.updatePluginMenu()
         return

tablexplore/app.py

@@ -33,6 +33,8 @@
 iconpath = os.path.join(module_path, 'icons')
 pluginiconpath = os.path.join(module_path, 'plugins', 'icons')
 settingspath = os.path.join(homepath, '.config','tablexplore')
+if not os.path.exists(settingspath):
+    os.makedirs(settingspath)
 cmapsfile = os.path.join(settingspath, 'cmaps.pkl')
 
 textalignment = None

tablexplore/core.py

@@ -32,7 +32,7 @@ class ExamplePlugin(Plugin):
     """Template plugin for TableExplore"""
 
     #uncomment capabilities list to appear in menu
-    capabilities = ['gui','docked']
+    capabilities = ['gui']
     requires = ['']
     menuentry = 'Example Plugin'
     name = 'Example Plugin'