diff README.rst @ 1:6c15d4e96b84 draft

planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
author gga
date Tue, 19 Sep 2017 12:26:10 -0400 (2017-09-19)
parents
children 52f0e9417dc1
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Tue Sep 19 12:26:10 2017 -0400
@@ -0,0 +1,46 @@
+Galaxy-tripal
+=============
+
+Galaxy tools to interface with Tripal using pyhon-tripal
+
+Dependencies
+------------
+
+You will need to install some python modules in the Galaxy virtualenv for these
+tools to be fully functional:
+
+.. code:: bash
+
+    . /path/to/galaxy/.venv/bin/activate
+    pip install future tripal
+    deactivate
+
+Environment
+-----------
+
+The following environment variables must be set:
+
++--------------------------------+-----------------------------------------------------------+
+| ENV                            | Use                                                       |
++================================+===========================================================+
+| ``$GALAXY_TRIPAL_URL``         | The URL at which Tripal is accessible, internal to Galaxy |
+|                                | and where the tools run. Must be absolute, with FQDN and  |
+|                                | protocol.                                                 |
++--------------------------------+-----------------------------------------------------------+
+| ``$GALAXY_TRIPAL_USER``        | The admin user which Galaxy should use to talk to Tripal. |
+|                                |                                                           |
++--------------------------------+-----------------------------------------------------------+
+| ``$GALAXY_TRIPAL_PASSWORD``    | The password for the admin user.                          |
+|                                |                                                           |
+|                                |                                                           |
++--------------------------------+-----------------------------------------------------------+
+| ``$GALAXY_TRIPAL_SHARED_DIR``  | Directory shared between Galaxy and Tripal, used to       |
+|                                | exchange data files.                                      |
++--------------------------------+-----------------------------------------------------------+
+
+
+License
+-------
+
+All python scripts, wrappers, and the webapollo.py are licensed under
+MIT license.