README

   1 This is Python version 3.0 final
   2 ================================
   3
   4 For notes specific to this release, see RELNOTES in this directory.
   5 Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
   6 Python Software Foundation.
   7 All rights reserved.
   8
   9 Python 3 (a.k.a. "Python 3000" or "Py3k", and released as Python 3.0) is a new
  10 version of the language, which is incompatible with the 2.x line of releases.
  11 The language is mostly the same, but many details, especially how built-in
  12 objects like dictionaries and strings work, have changed considerably, and a
  13 lot of deprecated features have finally been removed.
  14
  15
  16 Documentation
  17 -------------
  18
  19 Documentation for Python 3.0 is online, updated twice a day:
  20
  21     http://docs.python.org/dev/3.0/
  22
  23 All documentation is also available online at the Python web site
  24 (http://docs.python.org/, see below).  It is available online for occasional
  25 reference, and it can be downloaded in many formats for faster local access.
  26 The documentation is downloadable in HTML, PostScript, PDF, LaTeX (through
  27 2.5), and reStructuredText (2.6, 3.0, and going forward) formats; the LaTeX
  28 and reStructuredText versions are primarily for documentation authors,
  29 translators, and people with special formatting requirements.
  30
  31 This is a work in progress; please help improve it!
  32
  33 The design documents for Python 3 are also online.  While the reference
  34 documentation is being updated, the PEPs are often the best source of
  35 information about new features.  Start by reading PEP 3000:
  36
  37     http://python.org/dev/peps/pep-3000/
  38
  39
  40 What's New
  41 ----------
  42
  43 For an overview of what's new in Python 3.0, see Guido van Rossum's blog at
  44 artima.com:
  45
  46     http://www.artima.com/weblogs/index.jsp?blogger=guido
  47
  48 We try to eventually have a comprehensive overview of the changes in the
  49 "What's New in Python 3.0" document, found at
  50
  51     http://docs.python.org/dev/3.0/whatsnew/3.0
  52
  53 Please help improve it!
  54
  55 For a more detailed change log, read Misc/NEWS, though this file, too, is
  56 incomplete, and also doesn't list anything merged in from the 2.6 release.
  57
  58 If you want to install multiple versions of Python see the section below
  59 entitled "Installing multiple versions".
  60
  61
  62 Proposals for enhancement
  63 -------------------------
  64
  65 If you have a proposal to change Python, you may want to send an email to the
  66 comp.lang.python or python-ideas mailing lists for initial feedback.  A Python
  67 Enhancement Proposal (PEP) may be submitted if your idea gains ground.  All
  68 current PEPs, as well as guidelines for submitting a new PEP, are listed at
  69 http://www.python.org/dev/peps/.
  70
  71
  72 Converting From Python 2.x to 3.0
  73 ---------------------------------
  74
  75 Python 2.6 contains features to help locating and updating code that needs to
  76 be changed when migrating to Python 3.
  77
  78 A source-to-source translation tool, "2to3", can take care of the
  79 mundane task of converting large amounts of source code.  It is not a
  80 complete solution but is complemented by the deprecation warnings in
  81 2.6.  This tool is currently available via the Subversion sandbox:
  82
  83     http://svn.python.org/view/sandbox/trunk/2to3/
  84
  85
  86 Installing multiple versions
  87 ----------------------------
  88
  89 On Unix and Mac systems if you intend to install multiple versions of Python
  90 using the same installation prefix (--prefix argument to the configure script)
  91 you must take care that your primary python executable is not overwritten by
  92 the installation of a different version.  All files and directories installed
  93 using "make altinstall" contain the major and minor version and can thus live
  94 side-by-side.  "make install" also creates ${prefix}/bin/python which refers
  95 to ${prefix}/bin/pythonX.Y.  If you intend to install multiple versions using
  96 the same prefix you must decide which version (if any) is your "primary"
  97 version.  Install that version using "make install".  Install all other
  98 versions using "make altinstall".
  99
 100 For example, if you want to install Python 2.5, 2.6 and 3.0 with 2.6 being the
 101 primary version, you would execute "make install" in your 2.6 build directory
 102 and "make altinstall" in the others.
 103
 104
 105 Issue Tracker and Mailing List
 106 ------------------------------
 107
 108 We're soliciting bug reports about all aspects of the language.  Fixes are
 109 also welcome, preferable in unified diff format.  Please use the issue
 110 tracker:
 111
 112     http://bugs.python.org/
 113
 114 If you're not sure whether you're dealing with a bug or a feature, use the
 115 mailing list:
 116
 117     python-3000@python.org
 118
 119 To subscribe to the list, use the Mailman form:
 120
 121     http://mail.python.org/mailman/listinfo/python-3000/
 122
 123
 124 Build Instructions
 125 ------------------
 126
 127 On Unix, Linux, BSD, OSX, and Cygwin:
 128
 129     ./configure
 130     make
 131     make test
 132     sudo make install    # or "make altinstall"
 133
 134 You can pass many options to the configure script; run "./configure
 135 --help" to find out more.  On OSX and Cygwin, the executable is called
 136 python.exe; elsewhere it's just python.
 137
 138 On Mac OS X, if you have configured Python with --enable-framework,
 139 you should use "make frameworkinstall" to do the installation.  Note
 140 that this installs the Python executable in a place that is not
 141 normally on your PATH, you may want to set up a symlink in
 142 /usr/local/bin.
 143
 144 On Windows, see PCbuild/readme.txt.
 145
 146 If you wish, you can create a subdirectory and invoke configure from
 147 there.  For example:
 148
 149     mkdir debug
 150     cd debug
 151     ../configure --with-pydebug
 152     make
 153     make test
 154
 155 (This will fail if you *also* built at the top-level directory.  You
 156 should do a "make clean" at the toplevel first.)
 157
 158
 159 Copyright and License Information
 160 ---------------------------------
 161
 162 Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
 163 Python Software Foundation.
 164 All rights reserved.
 165
 166 Copyright (c) 2000 BeOpen.com.
 167 All rights reserved.
 168
 169 Copyright (c) 1995-2001 Corporation for National Research Initiatives.
 170 All rights reserved.
 171
 172 Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
 173 All rights reserved.
 174
 175 See the file "LICENSE" for information on the history of this
 176 software, terms & conditions for usage, and a DISCLAIMER OF ALL
 177 WARRANTIES.
 178
 179 This Python distribution contains *no* GNU General Public License
 180 (GPL) code, so it may be used in proprietary projects.  There are
 181 interfaces to some GNU code but these are entirely optional.
 182
 183 All trademarks referenced herein are property of their respective
 184 holders.