GeezerVison is showing github.com — ipython/setup.py at master · laprice/ipython

Expand file tree

setup.py

Copy path

More file actions

Latest commit

History

executable file

356 lines (295 loc) · 13 KB

setup.py

Copy path

File metadata and controls

executable file

356 lines (295 loc) · 13 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

#!/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

requires utilities which are not available under Windows."""

#-----------------------------------------------------------------------------

# Distributed under the terms of the Modified BSD License.

# The full license is in the file COPYING.txt, distributed with this software.

#-----------------------------------------------------------------------------

# Minimal Python version sanity check

#-----------------------------------------------------------------------------

from __future__ import print_function

import sys

# This check is also made in IPython/__init__, don't forget to update both when

# changing Python version requirements.

if sys.version_info[:2] < (2,7):

error = "ERROR: IPython requires Python Version 2.7 or above."

print(error, file=sys.stderr)

sys.exit(1)

PY3 = (sys.version_info[0] >= 3)

# At least we're on the python version we need, move on.

#-------------------------------------------------------------------------------

# Imports

#-------------------------------------------------------------------------------

# Stdlib imports

import os

import shutil

from glob import glob

# 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

# On Python 3, we need distribute (new setuptools) to do the 2to3 conversion

if PY3:

import setuptools

# Our own imports

from setupbase import target_update

from setupbase import (

setup_args,

find_packages,

find_package_data,

find_scripts,

find_data_files,

check_for_dependencies,

git_prebuild,

check_submodule_status,

update_submodules,

require_submodules,

UpdateSubmodules,

CompileCSS,

)

from setupext import setupext

isfile = os.path.isfile

pjoin = os.path.join

#-----------------------------------------------------------------------------

# Function definitions

#-----------------------------------------------------------------------------

def cleanup():

"""Clean up the junk left around by the build process"""

if "develop" not in sys.argv and "egg_info" not in sys.argv:

try:

shutil.rmtree('ipython.egg-info')

except:

try:

os.unlink('ipython.egg-info')

except:

pass

#-------------------------------------------------------------------------------

# Handle OS specific things

#-------------------------------------------------------------------------------

if os.name in ('nt','dos'):

os_name = 'windows'

else:

os_name = os.name

# 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.

if os_name == 'windows' and 'sdist' in sys.argv:

print('The sdist command is not available under Windows. Exiting.')

sys.exit(1)

#-------------------------------------------------------------------------------

# Make sure we aren't trying to run without submodules

#-------------------------------------------------------------------------------

here = os.path.abspath(os.path.dirname(__file__))

def require_clean_submodules():

"""Check on git submodules before distutils can do anything

Since distutils cannot be trusted to update the tree

after everything has been set in motion,

this is not a distutils command.

"""

# PACKAGERS: Add a return here to skip checks for git submodules

# don't do anything if nothing is actually supposed to happen

for do_nothing in ('-h', '--help', '--help-commands', 'clean', 'submodule'):

if do_nothing in sys.argv:

return

status = check_submodule_status(here)

if status == "missing":

print("checking out submodules for the first time")

update_submodules(here)

elif status == "unclean":

print('\n'.join([

"Cannot build / install IPython with unclean submodules",

"Please update submodules with",

" python setup.py submodule",

"or",

" git submodule update",

"or commit any submodule changes you have made."

]))

sys.exit(1)

require_clean_submodules()

#-------------------------------------------------------------------------------

# Things related to the IPython documentation

#-------------------------------------------------------------------------------

# update the manuals when building a source dist

if len(sys.argv) >= 2 and sys.argv[1] in ('sdist','bdist_rpm'):

import textwrap

# List of things to be updated. Each entry is a triplet of args for

# target_update()

to_update = [

# FIXME - Disabled for now: we need to redo an automatic way

# of generating the magic info inside the rst.

#('docs/magic.tex',

#['IPython/Magic.py'],

#"cd doc && ./update_magic.sh" ),

('docs/man/ipcluster.1.gz',

['docs/man/ipcluster.1'],

'cd docs/man && gzip -9c ipcluster.1 > ipcluster.1.gz'),

('docs/man/ipcontroller.1.gz',

['docs/man/ipcontroller.1'],

'cd docs/man && gzip -9c ipcontroller.1 > ipcontroller.1.gz'),

('docs/man/ipengine.1.gz',

['docs/man/ipengine.1'],

'cd docs/man && gzip -9c ipengine.1 > ipengine.1.gz'),

('docs/man/iplogger.1.gz',

['docs/man/iplogger.1'],

'cd docs/man && gzip -9c iplogger.1 > iplogger.1.gz'),

('docs/man/ipython.1.gz',

['docs/man/ipython.1'],

'cd docs/man && gzip -9c ipython.1 > ipython.1.gz'),

('docs/man/irunner.1.gz',

['docs/man/irunner.1'],

'cd docs/man && gzip -9c irunner.1 > irunner.1.gz'),

('docs/man/pycolor.1.gz',

['docs/man/pycolor.1'],

'cd docs/man && gzip -9c pycolor.1 > pycolor.1.gz'),

]

[ target_update(*t) for t in to_update ]

#---------------------------------------------------------------------------

# Find all the packages, package data, and data_files

#---------------------------------------------------------------------------

packages = find_packages()

package_data = find_package_data()

data_files = find_data_files()

setup_args['packages'] = packages

setup_args['package_data'] = package_data

setup_args['data_files'] = data_files

#---------------------------------------------------------------------------

# custom distutils commands

#---------------------------------------------------------------------------

# imports here, so they are after setuptools import if there was one

from distutils.command.sdist import sdist

from distutils.command.upload import upload

class UploadWindowsInstallers(upload):

description = "Upload Windows installers to PyPI (only used from tools/release_windows.py)"

user_options = upload.user_options + [

('files=', 'f', 'exe file (or glob) to upload')

]

def initialize_options(self):

upload.initialize_options(self)

meta = self.distribution.metadata

base = '{name}-{version}'.format(

name=meta.get_name(),

version=meta.get_version()

)

self.files = os.path.join('dist', '%s.*.exe' % base)

def run(self):

for dist_file in glob(self.files):

self.upload_file('bdist_wininst', 'any', dist_file)

setup_args['cmdclass'] = {

'build_py': git_prebuild('IPython'),

'sdist' : git_prebuild('IPython', sdist),

'upload_wininst' : UploadWindowsInstallers,

'submodule' : UpdateSubmodules,

'css' : CompileCSS,

}

#---------------------------------------------------------------------------

# Handle scripts, dependencies, and setuptools specific things

#---------------------------------------------------------------------------

# For some commands, use setuptools. Note that we do NOT list install here!

# If you want a setuptools-enhanced install, just run 'setupegg.py install'

needs_setuptools = set(('develop', 'release', 'bdist_egg', 'bdist_rpm',

'bdist', 'bdist_dumb', 'bdist_wininst', 'install_egg_info',

'egg_info', 'easy_install', 'upload',

))

if sys.platform == 'win32':

# Depend on setuptools for install on *Windows only*

# If we get script-installation working without setuptools,

# then we can back off, but until then use it.

# See Issue #369 on GitHub for more

needs_setuptools.add('install')

if len(needs_setuptools.intersection(sys.argv)) > 0:

import setuptools

# This dict is used for passing extra arguments that are setuptools

# specific to setup

setuptools_extra_args = {}

if 'setuptools' in sys.modules:

# setup.py develop should check for submodules

from setuptools.command.develop import develop

setup_args['cmdclass']['develop'] = require_submodules(develop)

setuptools_extra_args['zip_safe'] = False

setuptools_extra_args['entry_points'] = find_scripts(True)

setup_args['extras_require'] = dict(

parallel = 'pyzmq>=2.1.11',

qtconsole = ['pyzmq>=2.1.11', 'pygments'],

zmq = 'pyzmq>=2.1.11',

doc = 'Sphinx>=0.3',

test = 'nose>=0.10.1',

notebook = ['tornado>=2.0', 'pyzmq>=2.1.11', 'jinja2'],

nbconvert = ['pygments', 'jinja2', 'Sphinx>=0.3']

)

everything = set()

for deps in setup_args['extras_require'].values():

if not isinstance(deps, list):

deps = [deps]

for dep in deps:

everything.add(dep)

setup_args['extras_require']['all'] = everything

requires = setup_args.setdefault('install_requires', [])

setupext.display_status = False

if not setupext.check_for_readline():

if sys.platform == 'darwin':

requires.append('readline')

elif sys.platform.startswith('win'):

# Pyreadline 64 bit windows issue solved in versions >=1.7.1

# Also solves issues with some older versions of pyreadline that

# satisfy the unconstrained depdendency.

requires.append('pyreadline>=1.7.1')

else:

pass

# do we want to install readline here?

# 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)

setup_args['data_files'].append(

['Scripts', ('scripts/ipython.ico', 'scripts/ipython_nb.ico')])

setup_args['scripts'] = [pjoin('scripts','ipython_win_post_install.py')]

setup_args['options'] = {"bdist_wininst":

{"install_script":

"ipython_win_post_install.py"}}

if PY3:

setuptools_extra_args['use_2to3'] = True

# we try to make a 2.6, 2.7, and 3.1 to 3.3 python compatible code

# so we explicitly disable some 2to3 fixes to be sure we aren't forgetting

# anything.

setuptools_extra_args['use_2to3_exclude_fixers'] = [

'lib2to3.fixes.fix_apply',

'lib2to3.fixes.fix_except',

'lib2to3.fixes.fix_has_key',

'lib2to3.fixes.fix_next',

'lib2to3.fixes.fix_repr',

'lib2to3.fixes.fix_tuple_params',

]

from setuptools.command.build_py import build_py

setup_args['cmdclass'] = {'build_py': git_prebuild('IPython', build_cmd=build_py)}

setuptools_extra_args['entry_points'] = find_scripts(True, suffix='3')

setuptools._dont_write_bytecode = True

else:

# If we are running without setuptools, call this function which will

# check for dependencies an inform the user what is needed. This is

# just to make life easy for users.

check_for_dependencies()

setup_args['scripts'] = find_scripts(False)

#---------------------------------------------------------------------------

# Do the actual setup now

#---------------------------------------------------------------------------

setup_args.update(setuptools_extra_args)

def main():

setup(**setup_args)

cleanup()

if __name__ == '__main__':

main()