annotate tool_dependencies.xml @ 3:fa2bd553c9e8 draft

Uploaded
author wolma
date Tue, 12 Aug 2014 11:47:26 -0400
parents 31526acd9603
children ecf7415d602c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
31526acd9603 Uploaded
wolma
parents:
diff changeset
1 <?xml version="1.0"?>
3
fa2bd553c9e8 Uploaded
wolma
parents: 2
diff changeset
2 <tool_dependency>
2
31526acd9603 Uploaded
wolma
parents:
diff changeset
3 <package name="python3" version="3.4.1">
31526acd9603 Uploaded
wolma
parents:
diff changeset
4 <install version="1.0">
31526acd9603 Uploaded
wolma
parents:
diff changeset
5 <actions>
31526acd9603 Uploaded
wolma
parents:
diff changeset
6 <action type="download_by_url">https://www.python.org/ftp/python/3.4.1/Python-3.4.1.tgz</action>
31526acd9603 Uploaded
wolma
parents:
diff changeset
7
31526acd9603 Uploaded
wolma
parents:
diff changeset
8 <action type="set_environment_for_install">
31526acd9603 Uploaded
wolma
parents:
diff changeset
9 <repository changeset_revision="31f1e69aae89" name="package_zlib_1_2_8" owner="iuc" toolshed="http://toolshed.g2.bx.psu.edu">
31526acd9603 Uploaded
wolma
parents:
diff changeset
10 <package name="zlib" version="1.2.8" />
31526acd9603 Uploaded
wolma
parents:
diff changeset
11 </repository>
31526acd9603 Uploaded
wolma
parents:
diff changeset
12 </action>
31526acd9603 Uploaded
wolma
parents:
diff changeset
13
31526acd9603 Uploaded
wolma
parents:
diff changeset
14 <action type="shell_command">
31526acd9603 Uploaded
wolma
parents:
diff changeset
15 # The python build system doesn't check CPATH / C(PLUS)_INCLUDE_PATH which is set by the depended-upon
31526acd9603 Uploaded
wolma
parents:
diff changeset
16 # tool definitions for these sources, but it does check CPPFLAGS / LDFLAGS
31526acd9603 Uploaded
wolma
parents:
diff changeset
17 # Currently not whitespace-safe, I haven't found a way yet to quote the *FLAGS values so that they are
31526acd9603 Uploaded
wolma
parents:
diff changeset
18 # correctly recognized by both the python build process and the compiler. But as galaxy itself isn't
31526acd9603 Uploaded
wolma
parents:
diff changeset
19 # whitespace-safe either it doesn't really matter (currently).
31526acd9603 Uploaded
wolma
parents:
diff changeset
20 oldifs="$IFS"
31526acd9603 Uploaded
wolma
parents:
diff changeset
21 IFS=":"
31526acd9603 Uploaded
wolma
parents:
diff changeset
22 for p in $CPLUS_INCLUDE_PATH
31526acd9603 Uploaded
wolma
parents:
diff changeset
23 do
31526acd9603 Uploaded
wolma
parents:
diff changeset
24 CPPFLAGS="$CPPFLAGS -I$p"
31526acd9603 Uploaded
wolma
parents:
diff changeset
25 done
31526acd9603 Uploaded
wolma
parents:
diff changeset
26 for p in $LD_LIBRARY_PATH
31526acd9603 Uploaded
wolma
parents:
diff changeset
27 do
31526acd9603 Uploaded
wolma
parents:
diff changeset
28 LDFLAGS="$LDFLAGS -L$p"
31526acd9603 Uploaded
wolma
parents:
diff changeset
29 done
31526acd9603 Uploaded
wolma
parents:
diff changeset
30 IFS="$oldifs"
31526acd9603 Uploaded
wolma
parents:
diff changeset
31 export CPPFLAGS
31526acd9603 Uploaded
wolma
parents:
diff changeset
32 export LDFLAGS
31526acd9603 Uploaded
wolma
parents:
diff changeset
33
31526acd9603 Uploaded
wolma
parents:
diff changeset
34 # Clear variables that may be used in Galaxy's extenal python 2 environment
31526acd9603 Uploaded
wolma
parents:
diff changeset
35 unset PYTHONPATH
31526acd9603 Uploaded
wolma
parents:
diff changeset
36 unset PYTHONHOME
31526acd9603 Uploaded
wolma
parents:
diff changeset
37
31526acd9603 Uploaded
wolma
parents:
diff changeset
38 ./configure --prefix="$INSTALL_DIR" --with-ensurepip \
31526acd9603 Uploaded
wolma
parents:
diff changeset
39 &amp;&amp; make \
31526acd9603 Uploaded
wolma
parents:
diff changeset
40 &amp;&amp; make install
31526acd9603 Uploaded
wolma
parents:
diff changeset
41 </action>
31526acd9603 Uploaded
wolma
parents:
diff changeset
42
31526acd9603 Uploaded
wolma
parents:
diff changeset
43 <action type="set_environment">
31526acd9603 Uploaded
wolma
parents:
diff changeset
44 <environment_variable action="prepend_to" name="PATH">$INSTALL_DIR/bin</environment_variable>
31526acd9603 Uploaded
wolma
parents:
diff changeset
45 <environment_variable action="prepend_to" name="LD_LIBRARY_PATH">$ENV[LD_LIBRARY_PATH]</environment_variable>
31526acd9603 Uploaded
wolma
parents:
diff changeset
46 <!-- clear PYTHONPATH, otherwise we will get Galaxy's Python 2 libraries in the Python 3 path. -->
31526acd9603 Uploaded
wolma
parents:
diff changeset
47 <environment_variable action="set_to" name="PYTHONPATH" />
31526acd9603 Uploaded
wolma
parents:
diff changeset
48 <environment_variable action="set_to" name="PYTHONHOME">$INSTALL_DIR</environment_variable>
31526acd9603 Uploaded
wolma
parents:
diff changeset
49 <environment_variable action="prepend_to" name="PKG_CONFIG_PATH">$INSTALL_DIR/lib/pkgconfig</environment_variable>
31526acd9603 Uploaded
wolma
parents:
diff changeset
50 </action>
31526acd9603 Uploaded
wolma
parents:
diff changeset
51 </actions>
31526acd9603 Uploaded
wolma
parents:
diff changeset
52 </install>
31526acd9603 Uploaded
wolma
parents:
diff changeset
53
31526acd9603 Uploaded
wolma
parents:
diff changeset
54 <readme>
31526acd9603 Uploaded
wolma
parents:
diff changeset
55 Python 3.4.1
31526acd9603 Uploaded
wolma
parents:
diff changeset
56
31526acd9603 Uploaded
wolma
parents:
diff changeset
57 The Python programming language version 3.
31526acd9603 Uploaded
wolma
parents:
diff changeset
58
31526acd9603 Uploaded
wolma
parents:
diff changeset
59 http://www.python.org
31526acd9603 Uploaded
wolma
parents:
diff changeset
60
31526acd9603 Uploaded
wolma
parents:
diff changeset
61
31526acd9603 Uploaded
wolma
parents:
diff changeset
62 A lean build of python 3.4.1. It does not include modules with external dependencies except for the zlib module, which requires the zlib library installed on your system. For a build with more such modules included look at https://toolshed.g2.bx.psu.edu/view/jankanis/package_python3_4 written by jankanis, of which this package is a shameless plagiarism.
31526acd9603 Uploaded
wolma
parents:
diff changeset
63
31526acd9603 Uploaded
wolma
parents:
diff changeset
64 Python as of version 3.3 includes a built-in virtual environment manager. To create a python 3 virtual env, include the following actions in your tool_dependencies.xml, e.g. for a package MY_TOOL_venv:
31526acd9603 Uploaded
wolma
parents:
diff changeset
65
31526acd9603 Uploaded
wolma
parents:
diff changeset
66 &lt;action type="set_environment_for_install"&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
67 &lt;repository name="python3" owner="wolma"&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
68 &lt;package name="python3" version="3.4.1" /&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
69 &lt;/repository&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
70 &lt;!-- other install time dependencies --&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
71 &lt;/action&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
72
31526acd9603 Uploaded
wolma
parents:
diff changeset
73 &lt;action type="shell_command"&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
74 # Unset any saved environment settings from parent virtual
31526acd9603 Uploaded
wolma
parents:
diff changeset
75 # environments, e.g. for python 2 or if Galaxy itself is running
31526acd9603 Uploaded
wolma
parents:
diff changeset
76 # from within a virtual environment.
31526acd9603 Uploaded
wolma
parents:
diff changeset
77 unset _OLD_VIRTUAL_PATH; unset _OLD_VIRTUAL_PYTHONHOME
31526acd9603 Uploaded
wolma
parents:
diff changeset
78 # Create virtual environment MY_TOOL_venv
31526acd9603 Uploaded
wolma
parents:
diff changeset
79 pyvenv MY_TOOL_venv
31526acd9603 Uploaded
wolma
parents:
diff changeset
80 # install python packages
31526acd9603 Uploaded
wolma
parents:
diff changeset
81 MY_TOOL_venv/bin/pip3 install {{NEEDED_PYTHON_PACKAGES}}
31526acd9603 Uploaded
wolma
parents:
diff changeset
82 &lt;/action&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
83
31526acd9603 Uploaded
wolma
parents:
diff changeset
84 &lt;action type="set_environment"&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
85
31526acd9603 Uploaded
wolma
parents:
diff changeset
86 &lt;!-- Setting the PYTHONPATH correctly can be a bit tricky, because you must
31526acd9603 Uploaded
wolma
parents:
diff changeset
87 make sure that the runtime PYTHONPATH from galaxy itself is not
31526acd9603 Uploaded
wolma
parents:
diff changeset
88 included, as it probably points to python 2 code that can crash a
31526acd9603 Uploaded
wolma
parents:
diff changeset
89 program if python 3 tries to load it.
31526acd9603 Uploaded
wolma
parents:
diff changeset
90
31526acd9603 Uploaded
wolma
parents:
diff changeset
91 If you only use a single virtual environment that is created
31526acd9603 Uploaded
wolma
parents:
diff changeset
92 specifically for a tool you are creating, you can just use a set_to
31526acd9603 Uploaded
wolma
parents:
diff changeset
93 like below.
31526acd9603 Uploaded
wolma
parents:
diff changeset
94
31526acd9603 Uploaded
wolma
parents:
diff changeset
95 If you create a virtual environment installation that is meant to be
31526acd9603 Uploaded
wolma
parents:
diff changeset
96 reused by other packages, the virtual environment should probably
31526acd9603 Uploaded
wolma
parents:
diff changeset
97 prepend its site-packages to the PYTHONPATH since a tool could be
31526acd9603 Uploaded
wolma
parents:
diff changeset
98 using python modules from several virtual environments. But in such a
31526acd9603 Uploaded
wolma
parents:
diff changeset
99 scenario the tool that uses these virtual environments should also
31526acd9603 Uploaded
wolma
parents:
diff changeset
100 depend directly on the python3 package, and this dependency should be
31526acd9603 Uploaded
wolma
parents:
diff changeset
101 listed before any virtual environment dependencies. This ensures that
31526acd9603 Uploaded
wolma
parents:
diff changeset
102 the python3 environment settings that clear PYTHONPATH are sourced
31526acd9603 Uploaded
wolma
parents:
diff changeset
103 first so galaxy's runtime PYTHONPATH is excluded. Virtual environments
31526acd9603 Uploaded
wolma
parents:
diff changeset
104 can then prepend their PYTHONPATHs to each other. --&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
105 &lt;environment_variable name="PYTHONPATH" action="set_to"&gt;$INSTALL_DIR/MY_TOOL_venv/lib/python3.4/site-packages&lt;/environment_variable&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
106 &lt;!-- All that is really needed to use a specific virtual environment is that the
31526acd9603 Uploaded
wolma
parents:
diff changeset
107 python interpreter in that environment is used, so add it to PATH --&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
108 &lt;environment_variable name="PATH" action="prepend_to"&gt;$INSTALL_DIR/MY_TOOL_venv/bin&lt;/environment_variable&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
109 &lt;!-- Clear incoming PYTHONHOME just like the venv's 'activate' command does --&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
110 &lt;environment_variable name="PYTHONHOME" action="set_to"&gt;&lt;/environment_variable&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
111 &lt;!-- To find shared libraries for python built-in modules such as libssl or libsqlite3
31526acd9603 Uploaded
wolma
parents:
diff changeset
112 we need to re-export LD_LIBRARY_PATH --&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
113 &lt;environment_variable name="LD_LIBRARY_PATH" action="prepend_to"&gt;$ENV[LD_LIBRARY_PATH]&lt;/environment_variable&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
114 &lt;/action&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
115
31526acd9603 Uploaded
wolma
parents:
diff changeset
116
31526acd9603 Uploaded
wolma
parents:
diff changeset
117 Then, in your MY_TOOL.xml add the following requirement:
31526acd9603 Uploaded
wolma
parents:
diff changeset
118
31526acd9603 Uploaded
wolma
parents:
diff changeset
119 &lt;requirements&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
120 &lt;requirement name="package" version="XXX"&gt;MY_TOOL_venv&lt;/requirement&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
121 &lt;/requirements&gt;
31526acd9603 Uploaded
wolma
parents:
diff changeset
122
31526acd9603 Uploaded
wolma
parents:
diff changeset
123 </readme>
31526acd9603 Uploaded
wolma
parents:
diff changeset
124
31526acd9603 Uploaded
wolma
parents:
diff changeset
125 </package>
31526acd9603 Uploaded
wolma
parents:
diff changeset
126 </tool_dependency>