Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 151 lines (106 sloc) 5.728 kb
5c75746 added sandbox install info
bernddorn authored
1 ==================
2 Installing Pyjamas
3 ==================
4
85db82c update README and INSTALL.txt
lkcl authored
5 BEFORE PROCEEDING READ THE FOLLOWING WARNING.
6
7 DO NOT install the pyjamas libraries into /usr/share/python-support,
8 /usr/lib/python2.N/site-packages or ANY location where the "standard"
9 python interpreter could possibly pick them up. The pyjamas libraries
10 have nothing to do with python libraries when used by the compiler,
11 and contain replacements for sys.py, time.py and other modules that
12 are critical to pyjamas. It goes without saying that if you overwrite
13 the standard python modules with the pyjamas equivalents, you will run into
14 massive problems. Don't do it.
15
789a975 get XMLHttpRequest event handling working in MSHTML
lkcl authored
16 Dependencies
17 ============
18
19 For pyjamas javascript compilation, you need python 2 - that's it.
20
21 For Pyjamas Desktop, you will need:
22
370cd12 update INSTALL.txt dependencies
lkcl authored
23 * python-jsonrpc which can be downloaded from http://json-rpc.org
24 if you wish to use JSONRPC.
25
fa7c052 mention Henk Punt from pyjd/windows.py
lkcl authored
26 * Win32 comtypes; or python-hulahop and python-xpcom, or a patched
370cd12 update INSTALL.txt dependencies
lkcl authored
27 version of pywebkitgtk and webkit-gobject
789a975 get XMLHttpRequest event handling working in MSHTML
lkcl authored
28
29 These are for the MSHTML, XULrunner and Webkit ports of Pyjamas
30 Desktop, respectively.
31
370cd12 update INSTALL.txt dependencies
lkcl authored
32 Win32:
33
34 * comtypes is available here: http://sourceforge.net/projects/comtypes/
35
36 XULrunner:
37
38 * python-xpcom requires XULrunner. it's _big_. it is recommended that
39 you use a standard gnu/linux distribution build. if you ever manage
40 to get XULrunner and python-xpcom compiled for win32, you are officially
41 a hero: please tell everyone about it on pyjamas-dev.
42
43 Webkit:
44
45 use this code, for now:
46 * http://github.com/lkcl/webkit/16401.master
47 * http://code.google.com/p/pywebkitgtk/issues/detail?id=13
789a975 get XMLHttpRequest event handling working in MSHTML
lkcl authored
48
d0c1c2b add warning about use of setup.py
lkcl authored
49 Developer Sandbox Setup
50 =======================
51
29a5259 add pyjd install guidelines
lkcl authored
52 "Sandbox" setup simply refers to an installation that can be used
53 where it is placed, on the filesystem, without affecting any other
54 installations. The consequences of performing a "sandbox" install
55 are that you can have as many "sandbox" installs as you like, each
56 completely unrelated and having absolutely nothing to do with each
57 other.
58
59 Zope, Django and many other python systems make prevalent use of
60 "sandbox" installs. Every django app is its own "sandbox". The
61 creation of a "sandbox" in python is actually incredibly simple:
62 all that is required is that a hard-coded path is inserted into
63 sys.path. This job is covered by bootstrap.py.
64
65 Pyjamas
66 -------
67
d0c1c2b add warning about use of setup.py
lkcl authored
68 In this directory run:
69
70 python bootstrap.py
71
582aac1 keesbos Added creation of bin/pyjd[.bat] and fixes for win32
keesbos authored
72 The files ``pyjd/__init__.py``, ``./bin/pyjsbuild``, ``./bin/pyjscompile``
73 and ``pyjd`` will be created, custom-tailored with hard-coded paths specific
74 to the exact absolute location that the bootstrap.py command is run from.
75 In this way, you will be able to install, test and use multiple versions
76 of Pyjamas, without cross-interference.
d0c1c2b add warning about use of setup.py
lkcl authored
77
78 As they contain hard-coded paths, these custom-tailored commands CANNOT
79 be "moved around". If you move the pyjamas installation, re-run bootstrap.py
80 to recreate the commands, with suitable hard-coded paths.
81
82 To build pyjamas apps see ``./bin/pyjsbuild --help``
83
582aac1 keesbos Added creation of bin/pyjd[.bat] and fixes for win32
keesbos authored
84 On windows the files ``pyjd/__init__.py``, ``./bin/pyjsbuild.py``,
85 ``./bin/pyjsbuild.bat``, ``./bin/pyjscompile.py`` ``./bin/pyjscompile.bat``
86 and ``pyjd.bat`` will be created. The .bat files are the commands to be used. They invoke the corresponding .py files (if any).
87
88
29a5259 add pyjd install guidelines
lkcl authored
89 Pyjamas Desktop
90 ---------------
91
92 Sandbox installs of Pyjamas Desktop are tricky. For pyjd applications
93 to work, you will need to be able to import pyjd (built using
94 python bootstrap.py: see above).
95
96 There are two options for doing this:
97
582aac1 keesbos Added creation of bin/pyjd[.bat] and fixes for win32
keesbos authored
98 1) export PYTHONPATH={path to pyjamas} (or use bin/pyjd, which does this)
29a5259 add pyjd install guidelines
lkcl authored
99
100 2) break the sandbox rules (specifically for pyjd) and run:
101
102 python run_bootstrap_first_then_pyjd_setup.py install
103
104 If you decide to break the sandbox rules for pyjd, then, just as above,
105 with pyjd/__init__.py containing hard-coded paths pointing to wherever
106 you happened to create the sandbox, you MUST not "move around" the
107 sandbox subdirectory, without also re-running bootstrap.py and re-running
108 "python run_bootstrap_first_then_pyjd_setup.py install".
d0c1c2b add warning about use of setup.py
lkcl authored
109
5c75746 added sandbox install info
bernddorn authored
110 System Installation
111 ===================
112
2d62650 goodbye bootstrap.py, goodbye zope buildout, hello simple python script ...
lkcl authored
113 If you are installing pyjamas system-wide, for use by MORE THAN ONE
39e7f48 update warning about system-wide installs
lkcl authored
114 developer of the same multi-user system, follow the instructions in
115 this section. If you are the only person using pyjamas, or you
116 intend to have several versions of pyjamas, DO NOT attempt a system-wide
117 install. In order to keep the pyjs-specific versions of libraries
118 such as the reimplementations of time.py, sys.py etc. there are some
119 tricky hoops that have to be jumped through. System-wide installs
120 should either be done by installing pre-built packages, or done WITH
121 EXTREME CARE. So - if you do not know what you are doing, and break your
122 system, tough luck: you should have listened.
d0c1c2b add warning about use of setup.py
lkcl authored
123
124 First, you must use bootstrap.py to create suitable ./bin/pyjsbuild
125 and ./bin/pyjscompile commands. For example:
c3d4f69 mention python setup.py install
lkcl authored
126
5076967 spelling mistake spotted by andrew macgregor (thank you!)
lkcl authored
127 python bootstrap.py /usr/bin /usr/share/pyjamas
d0c1c2b add warning about use of setup.py
lkcl authored
128
85db82c update README and INSTALL.txt
lkcl authored
129 After ./pyjd/__init__.py, ./bin/pyjsbuild and ./bin/pyjscompile have been
130 created, they can now be installed system-wide, along with the libraries.
d0c1c2b add warning about use of setup.py
lkcl authored
131
132 python run_bootstrap_first_then_setup.py install
c3d4f69 mention python setup.py install
lkcl authored
133
2d62650 goodbye bootstrap.py, goodbye zope buildout, hello simple python script ...
lkcl authored
134 You *may* need to specify --install-data={pickasuitablelocation}
d0c1c2b add warning about use of setup.py
lkcl authored
135 and you *may* need to specify the same location to the bootstrap.py
136 command (prior to running run_bootstrap_first_then_setup.py)
137
85db82c update README and INSTALL.txt
lkcl authored
138 python bootstrap.py /usr/bin {pickasuitablelocation}
2d62650 goodbye bootstrap.py, goodbye zope buildout, hello simple python script ...
lkcl authored
139
c3d4f69 mention python setup.py install
lkcl authored
140 The commands pyjscompile and pyjsbuild will be installed;
141 the boilerplate web templates, the pyjamas "builtin" libraries
142 and the UI Widget libraries will be installed as data libraries
143 which pyjscompile and pyjsbuild will know about. The default
144 path is:
145
146 {sys.prefix}/share/pyjamas
147
148 You can over-ride this default location with the PYJSPREFIX
149 environment variable.
5c75746 added sandbox install info
bernddorn authored
150
Something went wrong with that request. Please try again.