##// END OF EJS Templates
synchronize with editor patch
synchronize with editor patch

File last commit:

r1207:c446b0e1
r1241:d7f37776
Show More
setup.py
186 lines | 6.8 KiB | text/x-python | PythonLexer
Ville M. Vainio
more crlf
r1033 #!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Setup script for IPython.
Under Posix environments it works like a typical setup.py script.
Under Windows, the command sdist is not supported, since IPython
Fernando Perez
Finish doc/build tools cleanup....
r1207 requires utilities which are not available under Windows."""
Ville M. Vainio
more crlf
r1033
#*****************************************************************************
# Copyright (C) 2001-2005 Fernando Perez <fperez@colorado.edu>
#
# Distributed under the terms of the BSD License. The full license is in
# the file COPYING, distributed as part of this software.
#*****************************************************************************
# Stdlib imports
import os
import sys
from glob import glob
Fernando Perez
Finish doc/build tools cleanup....
r1207
# BEFORE importing distutils, remove MANIFEST. distutils doesn't properly
# update it when the contents of directories change.
if os.path.exists('MANIFEST'): os.remove('MANIFEST')
from distutils.core import setup
Ville M. Vainio
more crlf
r1033 from setupext import install_data_ext
Fernando Perez
Finish doc/build tools cleanup....
r1207 # Local imports
from IPython.genutils import target_update
Ville M. Vainio
more crlf
r1033 # A few handy globals
isfile = os.path.isfile
pjoin = os.path.join
Fernando Perez
Finish doc/build tools cleanup....
r1207 ##############################################################################
# Utility functions
def oscmd(s):
print ">", s
os.system(s)
# A little utility we'll need below, since glob() does NOT allow you to do
# exclusion on multiple endings!
def file_doesnt_endwith(test,endings):
"""Return true if test is a file and its name does NOT end with any
of the strings listed in endings."""
if not isfile(test):
return False
for e in endings:
if test.endswith(e):
return False
return True
###############################################################################
# Main code begins
Ville M. Vainio
more crlf
r1033
if os.name == 'posix':
os_name = 'posix'
elif os.name in ['nt','dos']:
os_name = 'windows'
else:
print 'Unsupported operating system:',os.name
sys.exit(1)
Fernando Perez
Finish doc/build tools cleanup....
r1207 # Under Windows, 'sdist' has not been supported. Now that the docs build with
# Sphinx it might work, but let's not turn it on until someone confirms that it
# actually works.
Ville M. Vainio
more crlf
r1033 if os_name == 'windows' and 'sdist' in sys.argv:
print 'The sdist command is not available under Windows. Exiting.'
sys.exit(1)
# update the manuals when building a source dist
if len(sys.argv) >= 2 and sys.argv[1] in ('sdist','bdist_rpm'):
Ville M. Vainio
Updated setup.py and do_sphinx.py for new manual distribution
r1188 import textwrap
Fernando Perez
Finish doc/build tools cleanup....
r1207
# List of things to be updated. Each entry is a triplet of args for
Ville M. Vainio
more crlf
r1033 # target_update()
Fernando Perez
Finish doc/build tools cleanup....
r1207 to_update = [ # The do_sphinx scripts builds html and pdf, so just one
# target is enough to cover all manual generation
('doc/manual/ipython.pdf',
['IPython/Release.py','doc/source/ipython.rst'],
"cd doc && python do_sphinx.py" ),
# FIXME - Disabled for now: we need to redo an automatic way
# of generating the magic info inside the rst.
#('doc/magic.tex',
#['IPython/Magic.py'],
#"cd doc && ./update_magic.sh" ),
('doc/ipython.1.gz',
['doc/ipython.1'],
"cd doc && gzip -9c ipython.1 > ipython.1.gz"),
('doc/pycolor.1.gz',
['doc/pycolor.1'],
"cd doc && gzip -9c pycolor.1 > pycolor.1.gz"),
]
[ target_update(*t) for t in to_update ]
Ville M. Vainio
more crlf
r1033
# Release.py contains version, authors, license, url, keywords, etc.
execfile(pjoin('IPython','Release.py'))
# I can't find how to make distutils create a nested dir. structure, so
# in the meantime do it manually. Butt ugly.
# Note that http://www.redbrick.dcu.ie/~noel/distutils.html, ex. 2/3, contain
# information on how to do this more cleanly once python 2.4 can be assumed.
# Thanks to Noel for the tip.
ville
setup.py: use package_data to grab UserConfig files, install UserConfig as normal package
r1180 docdirbase = 'share/doc/ipython'
Ville M. Vainio
more crlf
r1033 manpagebase = 'share/man/man1'
# We only need to exclude from this things NOT already excluded in the
# MANIFEST.in file.
exclude = ('.sh','.1.gz')
docfiles = filter(lambda f:file_doesnt_endwith(f,exclude),glob('doc/*'))
examfiles = filter(isfile, glob('doc/examples/*.py'))
Fernando Perez
Finish doc/build tools cleanup....
r1207 manfiles = filter(isfile, glob('doc/manual/*'))
manstatic = filter(isfile, glob('doc/manual/_static/*'))
Ville M. Vainio
more crlf
r1033 manpages = filter(isfile, glob('doc/*.1.gz'))
Fernando Perez
Finish doc/build tools cleanup....
r1207
Ville M. Vainio
more crlf
r1033 cfgfiles = filter(isfile, glob('IPython/UserConfig/*'))
scriptfiles = filter(isfile, ['scripts/ipython','scripts/pycolor',
'scripts/irunner'])
Fernando Perez
Finish doc/build tools cleanup....
r1207
Ville M. Vainio
more crlf
r1033 igridhelpfiles = filter(isfile, glob('IPython/Extensions/igrid_help.*'))
# Script to be run by the windows binary installer after the default setup
# routine, to add shortcuts and similar windows-only things. Windows
# post-install scripts MUST reside in the scripts/ dir, otherwise distutils
# doesn't find them.
if 'bdist_wininst' in sys.argv:
if len(sys.argv) > 2 and ('sdist' in sys.argv or 'bdist_rpm' in sys.argv):
print >> sys.stderr,"ERROR: bdist_wininst must be run alone. Exiting."
sys.exit(1)
scriptfiles.append('scripts/ipython_win_post_install.py')
datafiles = [('data', docdirbase, docfiles),
('data', pjoin(docdirbase, 'examples'),examfiles),
('data', pjoin(docdirbase, 'manual'),manfiles),
Ville M. Vainio
Updated setup.py and do_sphinx.py for new manual distribution
r1188 ('data', pjoin(docdirbase, 'manual/_static'),manstatic),
Ville M. Vainio
more crlf
r1033 ('data', manpagebase, manpages),
('data',pjoin(docdirbase, 'extensions'),igridhelpfiles),
]
if 'setuptools' in sys.modules:
# setuptools config for egg building
egg_extra_kwds = {
'entry_points': {
'console_scripts': [
'ipython = IPython.ipapi:launch_new_instance',
'pycolor = IPython.PyColorize:main'
]}
}
scriptfiles = []
Fernando Perez
Finish doc/build tools cleanup....
r1207 # eggs will lack docs, examples
Ville M. Vainio
more crlf
r1033 datafiles = []
else:
Fernando Perez
Finish doc/build tools cleanup....
r1207 # Normal, non-setuptools install
Ville M. Vainio
more crlf
r1033 egg_extra_kwds = {}
ville
setup.py: use package_data to grab UserConfig files, install UserConfig as normal package
r1180 # package_data of setuptools was introduced to distutils in 2.4
if sys.version_info < (2,4):
datafiles.append(('lib', 'IPython/UserConfig', cfgfiles))
Ville M. Vainio
more crlf
r1033 # Call the setup() routine which does most of the work
setup(name = name,
version = version,
description = description,
long_description = long_description,
author = authors['Fernando'][0],
author_email = authors['Fernando'][1],
url = url,
download_url = download_url,
license = license,
platforms = platforms,
keywords = keywords,
Fernando Perez
Finish doc/build tools cleanup....
r1207 packages = ['IPython', 'IPython.Extensions', 'IPython.external',
'IPython.gui', 'IPython.gui.wx',
'IPython.UserConfig'],
Ville M. Vainio
more crlf
r1033 scripts = scriptfiles,
ville
setup.py: use package_data to grab UserConfig files, install UserConfig as normal package
r1180 package_data = {'IPython.UserConfig' : ['*'] },
Ville M. Vainio
more crlf
r1033
cmdclass = {'install_data': install_data_ext},
data_files = datafiles,
# extra params needed for eggs
**egg_extra_kwds
)