setup.py

   1 #!/usr/bin/env python
   2 """Distutils based setup script for Sympy.
   3
   4 This uses Distutils (http://python.org/sigs/distutils-sig/) the standard
   5 python mechanism for installing packages. For the easiest installation
   6 just type the command (you'll probably need root privileges for that):
   7
   8     python setup.py install
   9
  10 This will install the library in the default location. For instructions on
  11 how to customize the install procedure read the output of:
  12
  13     python setup.py --help install
  14
  15 In addition, there are some other commands:
  16
  17     python setup.py clean -> will clean all trash (*.pyc and stuff)
  18     python setup.py test  -> will run the complete test suite
  19     python setup.py test_core -> will run only tests concerning core features
  20     python setup.py test_doc -> will run tests on the examples of the documentation
  21
  22 To get a full list of avaiable commands, read the output of:
  23
  24     python setup.py --help-commands
  25
  26 Or, if all else fails, feel free to write to the sympy list at
  27 sympy@googlegroups.com and ask for help.
  28 """
  29
  30 from distutils.core import setup
  31 from distutils.core import Command
  32 import sys
  33
  34 import sympy
  35
  36 # Make sure I have the right Python version.
  37 if sys.version_info[1] < 4:
  38     print "Sympy requires Python 2.4 or newer. Python %d.%d detected" % \
  39           sys.version_info[:2]
  40     sys.exit(-1)
  41
  42 #Check that this list is uptodate against the result of the command:
  43 #$ find * -name __init__.py |sort
  44 modules = [
  45     # do docstring # module name # omit those even if the first field is True
  46     ( True, 'sympy.concrete', [] ),
  47     ( True, 'sympy.core', ['add', 'mul', 'relational', 'interval', 'ast_parser'] ),
  48     ( True, 'sympy.functions', [] ),
  49     ( True, 'sympy.functions.combinatorial', [] ),
  50     ( True, 'sympy.functions.elementary',
  51         ['miscellaneous', 'trigonometric', 'hyperbolic', 'exponential'] ),
  52     ( False, 'sympy.functions.special', [] ),
  53     ( True, 'sympy.geometry', [] ),
  54     ( True, 'sympy.integrals', [] ),
  55     ( True, 'sympy.interactive', [] ),
  56     ( True, 'sympy.matrices', [] ),
  57     ( True, 'sympy.ntheory', [] ),
  58     ( True, 'sympy.numerics', [] ),
  59     ( False, 'sympy.parsing', [] ),
  60     ( True, 'sympy.physics', [] ),
  61     ( False, 'sympy.plotting', [] ),
  62     ( False, 'sympy.thirdparty.mpmath', [] ),
  63     ( False, 'sympy.thirdparty.mpmath.lib', [] ),
  64     ( True, 'sympy.polynomials', [] ),
  65     ( True, 'sympy.polynomials.fast', [] ),
  66     ( True, 'sympy.polys', [] ),
  67     ( True, 'sympy.printing', ['gtk'] ),
  68     ( True, 'sympy.printing.pretty', [] ),
  69     ( True, 'sympy.series', ["limits"] ),
  70     ( True, 'sympy.simplify', [] ),
  71     ( True, 'sympy.solvers', [] ),
  72     ( True, 'sympy.specfun', [] ),
  73     ( True, 'sympy.statistics', [] ),
  74     ( True, 'sympy.utilities', [] ),
  75     ( True, 'sympy.utilities.mathml', [] ),
  76     ]
  77
  78 class clean(Command):
  79     """Cleans *.pyc and debian trashs, so you should get the same copy as
  80     is in the svn.
  81     """
  82
  83     description = "Clean everything"
  84     user_options = [("all","a","the same")]
  85
  86     def initialize_options(self):
  87         self.all = None
  88
  89     def finalize_options(self):
  90         pass
  91
  92     def run(self):
  93         import os
  94         os.system("py.cleanup")
  95         os.system("rm -f python-build-stamp-2.4")
  96         os.system("rm -f MANIFEST")
  97         os.system("rm -rf build")
  98         os.system("rm -rf dist")
  99
 100 class gen_doc(Command):
 101     """Generate the (html) api documentation using epydoc
 102
 103     output is sent to the directory ../api/
 104     """
 105
 106     description = "generate the api doc"
 107     user_options = []
 108
 109     target_dir = "../api/"
 110
 111     def initialize_options(self):
 112         self.all = None
 113
 114     def finalize_options(self):
 115         pass
 116
 117     def run(self):
 118         import os
 119         os.system("epydoc --no-frames -o %s sympy" % self.target_dir)
 120
 121
 122 class test_sympy_core(Command):
 123     """Run only the tests concerning features of sympy.core.
 124     It's a lot faster than running the complete test suite.
 125     """
 126
 127     description = "Automatically run the core test suite for Sympy."
 128     user_options = []  # distutils complains if this is not here.
 129
 130     def initialize_options(self):  # distutils wants this
 131         pass
 132
 133     def finalize_options(self):    # this too
 134         pass
 135
 136
 137     def run(self):
 138         try:
 139             import py
 140         except ImportError:
 141             print """In order to run the tests, you need codespeak's py.lib
 142             web page: http://codespeak.net/py/dist/
 143             If you are on debian systems, the package is named python-codespeak-lib
 144             """
 145             sys.exit(-1)
 146         py.test.cmdline.main(args=["sympy/core/tests"])
 147
 148
 149 class test_sympy(Command):
 150     """Runs all tests under the sympy/ folder
 151     """
 152
 153     description = "Automatically run the test suite for Sympy."
 154     user_options = []  # distutils complains if this is not here.
 155
 156     def __init__(self, *args):
 157         self.args = args[0] # so we can pass it to other classes
 158         Command.__init__(self, *args)
 159
 160     def initialize_options(self):  # distutils wants this
 161         pass
 162
 163     def finalize_options(self):    # this too
 164         pass
 165
 166     def run(self):
 167         try:
 168             import py as pylib
 169         except ImportError:
 170             print """In order to run the tests, you need codespeak's py.lib
 171             web page: http://codespeak.net/py/dist/
 172             If you are on debian systems, the package is named python-codespeak-lib
 173             """
 174             sys.exit(-1)
 175         pylib.test.cmdline.main(args=["sympy"])
 176         tdoc = test_sympy_doc(self.args)
 177         tdoc.run() # run also the doc test suite
 178
 179 class test_sympy_doc(Command):
 180
 181     description = "Run the tests for the examples in the documentation"
 182     user_options = []  # distutils complains if this is not here.
 183
 184     def initialize_options(self):  # distutils wants this
 185         pass
 186
 187     def finalize_options(self):    # this too
 188         pass
 189
 190     def run(self):
 191         import unittest
 192         import doctest
 193
 194         import glob
 195
 196         print "Testing docstrings."
 197
 198         def setup_pprint(doctest):
 199             from sympy import pprint_use_unicode
 200             # use ascii pprint in doctests
 201             pprint_use_unicode(False)
 202
 203         suite = unittest.TestSuite()
 204
 205         for perform, module, specific in modules:
 206             if perform == True:
 207                 path = module.replace('.', '/')
 208
 209                 items = glob.glob(path + '/[a-z][a-z0-9_]*.py')
 210                 items = [ i.replace('\\', '/') for i in items ]
 211
 212                 for omit in specific:
 213                     items.remove(path + '/' + omit + '.py')
 214
 215                 for item in items:
 216                     module = item.replace('/', '.')[:-3]
 217                     suite.addTest(doctest.DocTestSuite(module, setUp=setup_pprint))
 218
 219         runner = unittest.TextTestRunner()
 220         runner.run(suite)
 221
 222 # Check that this list is uptodate against the result of the command:
 223 # $ python bin/generate_test_list.py
 224 tests = [
 225     'sympy.concrete.tests',
 226     'sympy.core.tests',
 227     'sympy.functions.combinatorial.tests',
 228     'sympy.functions.elementary.tests',
 229     'sympy.functions.special.tests',
 230     'sympy.geometry.tests',
 231     'sympy.integrals.tests',
 232     'sympy.matrices.tests',
 233     'sympy.ntheory.tests',
 234     'sympy.numerics.tests',
 235     'sympy.parsing.tests',
 236     'sympy.physics.tests',
 237     'sympy.plotting.tests',
 238     'sympy.polynomials.tests',
 239     'sympy.polys.tests',
 240     'sympy.printing.tests',
 241     'sympy.series.tests',
 242     'sympy.simplify.tests',
 243     'sympy.solvers.tests',
 244     'sympy.specfun.tests',
 245     'sympy.statistics.tests',
 246     'sympy.test_external',
 247     'sympy.utilities.tests',
 248     ]
 249
 250 # update the following list from:
 251 # http://pyglet.googlecode.com/svn/trunk/setup.py
 252 # (whenever we update pyglet in sympy)
 253 pyglet_packages=[
 254     'pyglet',
 255     'pyglet.gl',
 256     'pyglet.font',
 257     'pyglet.image',
 258     'pyglet.image.codecs',
 259     'pyglet.media',
 260     'pyglet.media.drivers',
 261     'pyglet.media.drivers.alsa',
 262     'pyglet.media.drivers.directsound',
 263     'pyglet.media.drivers.openal',
 264     'pyglet.window',
 265     'pyglet.window.carbon',
 266     'pyglet.window.win32',
 267     'pyglet.window.xlib',
 268 ]
 269 pyglet_packages = ["sympy.thirdparty.pyglet." + s for s in pyglet_packages]
 270
 271 setup(
 272       name = 'sympy',
 273       version = sympy.__version__,
 274       description = 'Computer algebra system (CAS) in Python',
 275       license = 'BSD',
 276       url = 'http://code.google.com/p/sympy',
 277       packages = ['sympy'] + [ m[1] for m in modules ] + tests + \
 278         pyglet_packages,
 279       scripts = ['bin/isympy'],
 280       ext_modules = [],
 281       package_data = { 'sympy.utilities.mathml' : ['data/*.xsl'] },
 282       data_files = [('share/man/man1', ['doc/man/isympy.1'])],
 283       cmdclass    = {'test': test_sympy,
 284                      'test_core' : test_sympy_core,
 285                      'test_doc' : test_sympy_doc,
 286                      'gen_doc' : gen_doc,
 287                      'clean' : clean,
 288                      },
 289       )