##// END OF EJS Templates
Minor fixes to setupexe.py and reorg.txt.
Brian Granger -
Show More
@@ -25,7 +25,7 b' IPython currently has the following sub-packages:'
25 25
26 26 * :mod:`IPython.config`
27 27
28 * :mod:`IPython.extensions`
28 * :mod:`IPython.Extensions`
29 29
30 30 * :mod:`IPython.external`
31 31
@@ -52,8 +52,7 b' We propose to create the following new sub-packages:'
52 52 interpreter, but none of its extended capabilities.
53 53
54 54 * :mod:`IPython.lib`. IPython has many extended capabilities that are not part
55 of the IPython core. These things will go here. Any better names than
56 :mod:`IPython.lib`?
55 of the IPython core. These things will go here.
57 56
58 57 * :mod:`IPython.utils`. This sub-package will contain anything that might
59 58 eventually be found in the Python standard library, like things in
@@ -71,7 +70,7 b' We propose to create the following new sub-packages:'
71 70 standards, but that we plan on keeping. To be moved out of this sub-package
72 71 a module needs to have a maintainer, tests and documentation.
73 72
74 Prodedure
73 Procedure
75 74 =========
76 75
77 76 1. Move the file to its new location with its new name.
@@ -91,184 +90,5 b' added for iplib, ipapi and Shell. The follow things still need to be done::'
91 90 * I need to modify iptests to properly skip modules that are no longer top
92 91 level modules.
93 92
94 * I Need to update the top level IPython/__init__.py file. We need to make
95 sure that as we change how this is setup, that all modules still import.
96
97 93 * When running python setup.py sdist, the Sphinx API docs fail to build
98 94 because of something going on with IPython.core.fakemodule
99
100 * :file:`extensions`. This needs to be gone through separately. Minimally,
101 the package should be renamed to :file:`extensions` and the PYTHONPATH
102 setting in __init__.py needs to be updated.
103
104 Where things have been moved
105 ============================
106
107 Top-level modules:
108
109 * :file:`background_jobs.py`. Move to :file:`IPython/lib/backgroundjobs.py`.
110
111 * :file:`ColorANSI.py`. Move to :file:`IPython/utils/coloransi.py`.
112
113 * :file:`completer.py`. Move to :file:`IPython/core/completer.py`.
114
115 * :file:`ConfigLoader.py`. Move to :file:`IPython/config/configloader.py`.
116
117 * :file:`CrashHandler.py`. Move to :file:`IPython/core/crashhandler`.
118
119 * :file:`Debugger.py`. Move to :file:`IPython/core/debugger.py`.
120
121 * :file:`deep_reload.py`. Move to :file:`IPython/lib/deepreload.py`.
122
123 * :file:`demo.py`. Move to :file:`IPython/lib/demo.py`.
124
125 * :file:`DPyGetOpt.py`. Move to :mod:`IPython.utils` and replace with newer options parser.
126
127 * :file:`dtutils.py`. Move to :file:`IPython.deathrow`.
128
129 * :file:`excolors.py`. Move to :file:`IPython.core` or :file:`IPython.config`.
130 Maybe move to :mod:`IPython.lib` or :mod:`IPython.python`?
131
132 * :file:`FakeModule.py`. Move to :file:`IPython/core/fakemodule.py`.
133
134 * :file:`generics.py`. Move to :file:`IPython.python`.
135
136 * :file:`genutils.py`. Move to :file:`IPython.utils`.
137
138 * :file:`Gnuplot2.py`. Move to :file:`IPython.sandbox`.
139
140 * :file:`GnuplotInteractive.py`. Move to :file:`IPython.sandbox`.
141
142 * :file:`GnuplotRuntime.py`. Move to :file:`IPython.sandbox`.
143
144 * :file:`numutils.py`. Move to :file:`IPython.sandbox`.
145
146 * :file:`twshell.py`. Move to :file:`IPython.sandbox`.
147
148 * :file:`history.py`. Move to :file:`IPython.core`.
149
150 * :file:`hooks.py`. Move to :file:`IPython.core`.
151
152 * :file:`ipapi.py`. Move to :file:`IPython.core`.
153
154 * :file:`iplib.py`. Move to :file:`IPython.core`.
155
156 * :file:`ipmaker.py`: Move to :file:`IPython.core`.
157
158 * :file:`ipstruct.py`. Move to :file:`IPython.python`.
159
160 * :file:`irunner.py`. Move to :file:`IPython.scripts`.
161
162 * :file:`Itpl.py`. Move to :file:`deathrow/Itpl.py`. Copy already in
163 :file:`IPython.external`.
164
165 * :file:`Logger.py`. Move to :file:`IPython/core/logger.py`.
166
167 * :file:`macro.py`. Move to :file:`IPython.core`.
168
169 * :file:`Magic.py`. Move to :file:`IPython/core/magic.py`.
170
171 * :file:`OInspect.py`. Move to :file:`IPython/core/oinspect.py`.
172
173 * :file:`OutputTrap.py`. Move to :file:`IPython/core/outputtrap.py`.
174
175 * :file:`platutils.py`. Move to :file:`IPython.python`.
176
177 * :file:`platutils_dummy.py`. Move to :file:`IPython.python`.
178
179 * :file:`platutils_posix.py`. Move to :file:`IPython.python`.
180
181 * :file:`platutils_win32.py`. Move to :file:`IPython.python`.
182
183 * :file:`prefilter.py`: Move to :file:`IPython.core`.
184
185 * :file:`Prompts.py`. Move to :file:`IPython/core/prompts.py` or
186 :file:`IPython/frontend/prompts.py`.
187
188 * :file:`PyColorize.py`. Move to :file:`IPython/utils/pycolorize.py`. Explore
189 replacing with pygments.
190
191 * :file:`Release.py`. Move to ??? or remove?
192
193 * :file:`rlineimpl.py`. Move to :file:`IPython.core`.
194
195 * :file:`shadowns.py`. Move to :file:`IPython.core`.
196
197 * :file:`Shell.py`. Move to :file:`IPython.core.shell.py` or
198 :file:`IPython/frontend/shell.py`.
199
200 * :file:`shellglobals.py`. Move to :file:`IPython.core`.
201
202 * :file:`strdispatch.py`. Move to :file:`IPython.python`.
203
204 * :file:`twshell.py`. Move to :file:`IPython.sandbox`.
205
206 * :file:`ultraTB.py`. Move to :file:`IPython/core/ultratb.py`.
207
208 * :file:`upgrade_dir.py`. Move to :file:`IPython/utils/upgradedir.py`.
209
210 * :file:`usage.py`. Move to :file:`IPython.core`.
211
212 * :file:`wildcard.py`. Move to :file:`IPython.utils`.
213
214 * :file:`winconsole.py`. Move to :file:`IPython.utils`.
215
216 Top-level sub-packages:
217
218 * :file:`testing`. Good where it is.
219
220 * :file:`tests`. Remove.
221
222 * :file:`tools`. Things in here need to be looked at and moved elsewhere like
223 :file:`IPython.utils`.
224
225 * :file:`UserConfig`. Move to :file:`IPython.config.userconfig`.
226
227 * :file:`config`. Good where it is!
228
229 * :file:`external`. Good where it is!
230
231 * :file:`frontend`. Good where it is!
232
233 * :file:`gui`. Eventually this should be moved to a subdir of
234 :file:`IPython.frontend`.
235
236 * :file:`kernel`. Good where it is.
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254 Other things
255 ============
256
257 When these files are moved around, a number of other things will happen at the same time:
258
259 1. Test files will be created for each module in IPython. Minimally, all
260 modules will be imported as a part of the test. This will serve as a
261 test of the module reorganization. These tests will be put into new
262 :file:`tests` subdirectories that each package will have.
263
264 2. PyFlakes and other code checkers will be run to look for problems.
265
266 3. Modules will be renamed to comply with PEP 8 naming conventions: all
267 lowercase and no special characters like ``-`` or ``_``.
268
269 4. Existing tests will be moved to the appropriate :file:`tests`
270 subdirectories.
271
272
273
274
@@ -43,7 +43,7 b' import py2exe'
43 43
44 44 # update the manuals when building a source dist
45 45 # Release.py contains version, authors, license, url, keywords, etc.
46 execfile(pjoin('IPython','Release.py'))
46 execfile(pjoin('IPython','core','release.py'))
47 47
48 48 # A little utility we'll need below, since glob() does NOT allow you to do
49 49 # exclusion on multiple endings!
@@ -65,7 +65,8 b' setup(name = name,'
65 65 options = {
66 66 'py2exe': {
67 67 'packages' : ['IPython', 'IPython.extensions', 'IPython.external',
68 'pyreadline'],
68 'pyreadline','config','core','deathrow','lib',
69 'scripts','testing','utils'],
69 70 'excludes' : ["Tkconstants","Tkinter","tcl",'IPython.igrid','wx',
70 71 'wxPython','igrid', 'PyQt4', 'zope', 'Zope', 'Zope2',
71 72 '_curses','enthought.traits','gtk','qt', 'pydb','idlelib',
General Comments 0
You need to be logged in to leave comments. Login now