DESCRIPTION.rst 76 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922
  1. ===============================
  2. Installing and Using Setuptools
  3. ===============================
  4. .. contents:: **Table of Contents**
  5. -------------------------
  6. Installation Instructions
  7. -------------------------
  8. The recommended way to bootstrap setuptools on any system is to download
  9. `ez_setup.py`_ and run it using the target Python environment. Different
  10. operating systems have different recommended techniques to accomplish this
  11. basic routine, so below are some examples to get you started.
  12. Setuptools requires Python 2.6 or later. To install setuptools
  13. on Python 2.4 or Python 2.5, use the `bootstrap script for Setuptools 1.x
  14. <https://bitbucket.org/pypa/setuptools/raw/bootstrap-py24/ez_setup.py>`_.
  15. The link provided to ez_setup.py is a bookmark to bootstrap script for the
  16. latest known stable release.
  17. .. _ez_setup.py: https://bootstrap.pypa.io/ez_setup.py
  18. Windows 8 (Powershell)
  19. ======================
  20. For best results, uninstall previous versions FIRST (see `Uninstalling`_).
  21. Using Windows 8 or later, it's possible to install with one simple Powershell
  22. command. Start up Powershell and paste this command::
  23. > (Invoke-WebRequest https://bootstrap.pypa.io/ez_setup.py).Content | python -
  24. You must start the Powershell with Administrative privileges or you may choose
  25. to install a user-local installation::
  26. > (Invoke-WebRequest https://bootstrap.pypa.io/ez_setup.py).Content | python - --user
  27. If you have Python 3.3 or later, you can use the ``py`` command to install to
  28. different Python versions. For example, to install to Python 3.3 if you have
  29. Python 2.7 installed::
  30. > (Invoke-WebRequest https://bootstrap.pypa.io/ez_setup.py).Content | py -3 -
  31. The recommended way to install setuptools on Windows is to download
  32. `ez_setup.py`_ and run it. The script will download the appropriate .egg
  33. file and install it for you.
  34. Once installation is complete, you will find an ``easy_install`` program in
  35. your Python ``Scripts`` subdirectory. For simple invocation and best results,
  36. add this directory to your ``PATH`` environment variable, if it is not already
  37. present. If you did a user-local install, the ``Scripts`` subdirectory is
  38. ``$env:APPDATA\Python\Scripts``.
  39. Windows 7 (or graphical install)
  40. ================================
  41. For Windows 7 and earlier, download `ez_setup.py`_ using your favorite web
  42. browser or other technique and "run" that file.
  43. Unix (wget)
  44. ===========
  45. Most Linux distributions come with wget.
  46. Download `ez_setup.py`_ and run it using the target Python version. The script
  47. will download the appropriate version and install it for you::
  48. > wget https://bootstrap.pypa.io/ez_setup.py -O - | python
  49. Note that you will may need to invoke the command with superuser privileges to
  50. install to the system Python::
  51. > wget https://bootstrap.pypa.io/ez_setup.py -O - | sudo python
  52. Alternatively, Setuptools may be installed to a user-local path::
  53. > wget https://bootstrap.pypa.io/ez_setup.py -O - | python - --user
  54. Unix including Mac OS X (curl)
  55. ==============================
  56. If your system has curl installed, follow the ``wget`` instructions but
  57. replace ``wget`` with ``curl`` and ``-O`` with ``-o``. For example::
  58. > curl https://bootstrap.pypa.io/ez_setup.py -o - | python
  59. Advanced Installation
  60. =====================
  61. For more advanced installation options, such as installing to custom
  62. locations or prefixes, download and extract the source
  63. tarball from `Setuptools on PyPI <https://pypi.python.org/pypi/setuptools>`_
  64. and run setup.py with any supported distutils and Setuptools options.
  65. For example::
  66. setuptools-x.x$ python setup.py install --prefix=/opt/setuptools
  67. Use ``--help`` to get a full options list, but we recommend consulting
  68. the `EasyInstall manual`_ for detailed instructions, especially `the section
  69. on custom installation locations`_.
  70. .. _EasyInstall manual: https://pythonhosted.org/setuptools/EasyInstall
  71. .. _the section on custom installation locations: https://pythonhosted.org/setuptools/EasyInstall#custom-installation-locations
  72. Downloads
  73. =========
  74. All setuptools downloads can be found at `the project's home page in the Python
  75. Package Index`_. Scroll to the very bottom of the page to find the links.
  76. .. _the project's home page in the Python Package Index: https://pypi.python.org/pypi/setuptools
  77. In addition to the PyPI downloads, the development version of ``setuptools``
  78. is available from the `Bitbucket repo`_, and in-development versions of the
  79. `0.6 branch`_ are available as well.
  80. .. _Bitbucket repo: https://bitbucket.org/pypa/setuptools/get/default.tar.gz#egg=setuptools-dev
  81. .. _0.6 branch: http://svn.python.org/projects/sandbox/branches/setuptools-0.6/#egg=setuptools-dev06
  82. Uninstalling
  83. ============
  84. On Windows, if Setuptools was installed using an ``.exe`` or ``.msi``
  85. installer, simply use the uninstall feature of "Add/Remove Programs" in the
  86. Control Panel.
  87. Otherwise, to uninstall Setuptools or Distribute, regardless of the Python
  88. version, delete all ``setuptools*`` and ``distribute*`` files and
  89. directories from your system's ``site-packages`` directory
  90. (and any other ``sys.path`` directories) FIRST.
  91. If you are upgrading or otherwise plan to re-install Setuptools or Distribute,
  92. nothing further needs to be done. If you want to completely remove Setuptools,
  93. you may also want to remove the 'easy_install' and 'easy_install-x.x' scripts
  94. and associated executables installed to the Python scripts directory.
  95. --------------------------------
  96. Using Setuptools and EasyInstall
  97. --------------------------------
  98. Here are some of the available manuals, tutorials, and other resources for
  99. learning about Setuptools, Python Eggs, and EasyInstall:
  100. * `The EasyInstall user's guide and reference manual`_
  101. * `The setuptools Developer's Guide`_
  102. * `The pkg_resources API reference`_
  103. * `Package Compatibility Notes`_ (user-maintained)
  104. * `The Internal Structure of Python Eggs`_
  105. Questions, comments, and bug reports should be directed to the `distutils-sig
  106. mailing list`_. If you have written (or know of) any tutorials, documentation,
  107. plug-ins, or other resources for setuptools users, please let us know about
  108. them there, so this reference list can be updated. If you have working,
  109. *tested* patches to correct problems or add features, you may submit them to
  110. the `setuptools bug tracker`_.
  111. .. _setuptools bug tracker: https://bitbucket.org/pypa/setuptools/issues
  112. .. _Package Compatibility Notes: https://pythonhosted.org/setuptools/PackageNotes
  113. .. _The Internal Structure of Python Eggs: https://pythonhosted.org/setuptools/formats.html
  114. .. _The setuptools Developer's Guide: https://pythonhosted.org/setuptools/setuptools.html
  115. .. _The pkg_resources API reference: https://pythonhosted.org/setuptools/pkg_resources.html
  116. .. _The EasyInstall user's guide and reference manual: https://pythonhosted.org/setuptools/easy_install.html
  117. .. _distutils-sig mailing list: http://mail.python.org/pipermail/distutils-sig/
  118. -------
  119. Credits
  120. -------
  121. * The original design for the ``.egg`` format and the ``pkg_resources`` API was
  122. co-created by Phillip Eby and Bob Ippolito. Bob also implemented the first
  123. version of ``pkg_resources``, and supplied the OS X operating system version
  124. compatibility algorithm.
  125. * Ian Bicking implemented many early "creature comfort" features of
  126. easy_install, including support for downloading via Sourceforge and
  127. Subversion repositories. Ian's comments on the Web-SIG about WSGI
  128. application deployment also inspired the concept of "entry points" in eggs,
  129. and he has given talks at PyCon and elsewhere to inform and educate the
  130. community about eggs and setuptools.
  131. * Jim Fulton contributed time and effort to build automated tests of various
  132. aspects of ``easy_install``, and supplied the doctests for the command-line
  133. ``.exe`` wrappers on Windows.
  134. * Phillip J. Eby is the seminal author of setuptools, and
  135. first proposed the idea of an importable binary distribution format for
  136. Python application plug-ins.
  137. * Significant parts of the implementation of setuptools were funded by the Open
  138. Source Applications Foundation, to provide a plug-in infrastructure for the
  139. Chandler PIM application. In addition, many OSAF staffers (such as Mike
  140. "Code Bear" Taylor) contributed their time and stress as guinea pigs for the
  141. use of eggs and setuptools, even before eggs were "cool". (Thanks, guys!)
  142. * Tarek Ziadé is the principal author of the Distribute fork, which
  143. re-invigorated the community on the project, encouraged renewed innovation,
  144. and addressed many defects.
  145. * Since the merge with Distribute, Jason R. Coombs is the
  146. maintainer of setuptools. The project is maintained in coordination with
  147. the Python Packaging Authority (PyPA) and the larger Python community.
  148. .. _files:
  149. =======
  150. CHANGES
  151. =======
  152. ---
  153. 3.6
  154. ---
  155. * `Issue #203 <https://bitbucket.org/pypa/setuptools/issue/203>`_: Honor proxy settings for Powershell downloader in the bootstrap
  156. routine.
  157. -----
  158. 3.5.2
  159. -----
  160. * `Issue #168 <https://bitbucket.org/pypa/setuptools/issue/168>`_: More robust handling of replaced zip files and stale caches.
  161. Fixes ZipImportError complaining about a 'bad local header'.
  162. -----
  163. 3.5.1
  164. -----
  165. * `Issue #199 <https://bitbucket.org/pypa/setuptools/issue/199>`_: Restored ``install._install`` for compatibility with earlier
  166. NumPy versions.
  167. ---
  168. 3.5
  169. ---
  170. * `Issue #195 <https://bitbucket.org/pypa/setuptools/issue/195>`_: Follow symbolic links in find_packages (restoring behavior
  171. broken in 3.4).
  172. * `Issue #197 <https://bitbucket.org/pypa/setuptools/issue/197>`_: On Python 3.1, PKG-INFO is now saved in a UTF-8 encoding instead
  173. of ``sys.getpreferredencoding`` to match the behavior on Python 2.6-3.4.
  174. * `Issue #192 <https://bitbucket.org/pypa/setuptools/issue/192>`_: Preferred bootstrap location is now
  175. https://bootstrap.pypa.io/ez_setup.py (mirrored from former location).
  176. -----
  177. 3.4.4
  178. -----
  179. * `Issue #184 <https://bitbucket.org/pypa/setuptools/issue/184>`_: Correct failure where find_package over-matched packages
  180. when directory traversal isn't short-circuited.
  181. -----
  182. 3.4.3
  183. -----
  184. * `Issue #183 <https://bitbucket.org/pypa/setuptools/issue/183>`_: Really fix test command with Python 3.1.
  185. -----
  186. 3.4.2
  187. -----
  188. * `Issue #183 <https://bitbucket.org/pypa/setuptools/issue/183>`_: Fix additional regression in test command on Python 3.1.
  189. -----
  190. 3.4.1
  191. -----
  192. * `Issue #180 <https://bitbucket.org/pypa/setuptools/issue/180>`_: Fix regression in test command not caught by py.test-run tests.
  193. ---
  194. 3.4
  195. ---
  196. * `Issue #176 <https://bitbucket.org/pypa/setuptools/issue/176>`_: Add parameter to the test command to support a custom test
  197. runner: --test-runner or -r.
  198. * `Issue #177 <https://bitbucket.org/pypa/setuptools/issue/177>`_: Now assume most common invocation to install command on
  199. platforms/environments without stack support (issuing a warning). Setuptools
  200. now installs naturally on IronPython. Behavior on CPython should be
  201. unchanged.
  202. ---
  203. 3.3
  204. ---
  205. * Add ``include`` parameter to ``setuptools.find_packages()``.
  206. ---
  207. 3.2
  208. ---
  209. * `Pull Request #39 <https://bitbucket.org/pypa/setuptools/pull-request/39>`_: Add support for C++ targets from Cython ``.pyx`` files.
  210. * `Issue #162 <https://bitbucket.org/pypa/setuptools/issue/162>`_: Update dependency on certifi to 1.0.1.
  211. * `Issue #164 <https://bitbucket.org/pypa/setuptools/issue/164>`_: Update dependency on wincertstore to 0.2.
  212. ---
  213. 3.1
  214. ---
  215. * `Issue #161 <https://bitbucket.org/pypa/setuptools/issue/161>`_: Restore Features functionality to allow backward compatibility
  216. (for Features) until the uses of that functionality is sufficiently removed.
  217. -----
  218. 3.0.2
  219. -----
  220. * Correct typo in previous bugfix.
  221. -----
  222. 3.0.1
  223. -----
  224. * `Issue #157 <https://bitbucket.org/pypa/setuptools/issue/157>`_: Restore support for Python 2.6 in bootstrap script where
  225. ``zipfile.ZipFile`` does not yet have support for context managers.
  226. ---
  227. 3.0
  228. ---
  229. * `Issue #125 <https://bitbucket.org/pypa/setuptools/issue/125>`_: Prevent Subversion support from creating a ~/.subversion
  230. directory just for checking the presence of a Subversion repository.
  231. * `Issue #12 <https://bitbucket.org/pypa/setuptools/issue/12>`_: Namespace packages are now imported lazily. That is, the mere
  232. declaration of a namespace package in an egg on ``sys.path`` no longer
  233. causes it to be imported when ``pkg_resources`` is imported. Note that this
  234. change means that all of a namespace package's ``__init__.py`` files must
  235. include a ``declare_namespace()`` call in order to ensure that they will be
  236. handled properly at runtime. In 2.x it was possible to get away without
  237. including the declaration, but only at the cost of forcing namespace
  238. packages to be imported early, which 3.0 no longer does.
  239. * `Issue #148 <https://bitbucket.org/pypa/setuptools/issue/148>`_: When building (bdist_egg), setuptools no longer adds
  240. ``__init__.py`` files to namespace packages. Any packages that rely on this
  241. behavior will need to create ``__init__.py`` files and include the
  242. ``declare_namespace()``.
  243. * `Issue #7 <https://bitbucket.org/pypa/setuptools/issue/7>`_: Setuptools itself is now distributed as a zip archive in addition to
  244. tar archive. ez_setup.py now uses zip archive. This approach avoids the potential
  245. security vulnerabilities presented by use of tar archives in ez_setup.py.
  246. It also leverages the security features added to ZipFile.extract in Python 2.7.4.
  247. * `Issue #65 <https://bitbucket.org/pypa/setuptools/issue/65>`_: Removed deprecated Features functionality.
  248. * `Pull Request #28 <https://bitbucket.org/pypa/setuptools/pull-request/28>`_: Remove backport of ``_bytecode_filenames`` which is
  249. available in Python 2.6 and later, but also has better compatibility with
  250. Python 3 environments.
  251. * `Issue #156 <https://bitbucket.org/pypa/setuptools/issue/156>`_: Fix spelling of __PYVENV_LAUNCHER__ variable.
  252. ---
  253. 2.2
  254. ---
  255. * `Issue #141 <https://bitbucket.org/pypa/setuptools/issue/141>`_: Restored fix for allowing setup_requires dependencies to
  256. override installed dependencies during setup.
  257. * `Issue #128 <https://bitbucket.org/pypa/setuptools/issue/128>`_: Fixed issue where only the first dependency link was honored
  258. in a distribution where multiple dependency links were supplied.
  259. -----
  260. 2.1.2
  261. -----
  262. * `Issue #144 <https://bitbucket.org/pypa/setuptools/issue/144>`_: Read long_description using codecs module to avoid errors
  263. installing on systems where LANG=C.
  264. -----
  265. 2.1.1
  266. -----
  267. * `Issue #139 <https://bitbucket.org/pypa/setuptools/issue/139>`_: Fix regression in re_finder for CVS repos (and maybe Git repos
  268. as well).
  269. ---
  270. 2.1
  271. ---
  272. * `Issue #129 <https://bitbucket.org/pypa/setuptools/issue/129>`_: Suppress inspection of ``*.whl`` files when searching for files
  273. in a zip-imported file.
  274. * `Issue #131 <https://bitbucket.org/pypa/setuptools/issue/131>`_: Fix RuntimeError when constructing an egg fetcher.
  275. -----
  276. 2.0.2
  277. -----
  278. * Fix NameError during installation with Python implementations (e.g. Jython)
  279. not containing parser module.
  280. * Fix NameError in ``sdist:re_finder``.
  281. -----
  282. 2.0.1
  283. -----
  284. * `Issue #124 <https://bitbucket.org/pypa/setuptools/issue/124>`_: Fixed error in list detection in upload_docs.
  285. ---
  286. 2.0
  287. ---
  288. * `Issue #121 <https://bitbucket.org/pypa/setuptools/issue/121>`_: Exempt lib2to3 pickled grammars from DirectorySandbox.
  289. * `Issue #41 <https://bitbucket.org/pypa/setuptools/issue/41>`_: Dropped support for Python 2.4 and Python 2.5. Clients requiring
  290. setuptools for those versions of Python should use setuptools 1.x.
  291. * Removed ``setuptools.command.easy_install.HAS_USER_SITE``. Clients
  292. expecting this boolean variable should use ``site.ENABLE_USER_SITE``
  293. instead.
  294. * Removed ``pkg_resources.ImpWrapper``. Clients that expected this class
  295. should use ``pkgutil.ImpImporter`` instead.
  296. -----
  297. 1.4.2
  298. -----
  299. * `Issue #116 <https://bitbucket.org/pypa/setuptools/issue/116>`_: Correct TypeError when reading a local package index on Python
  300. 3.
  301. -----
  302. 1.4.1
  303. -----
  304. * `Issue #114 <https://bitbucket.org/pypa/setuptools/issue/114>`_: Use ``sys.getfilesystemencoding`` for decoding config in
  305. ``bdist_wininst`` distributions.
  306. * `Issue #105 <https://bitbucket.org/pypa/setuptools/issue/105>`_ and `Issue #113 <https://bitbucket.org/pypa/setuptools/issue/113>`_: Establish a more robust technique for
  307. determining the terminal encoding::
  308. 1. Try ``getpreferredencoding``
  309. 2. If that returns US_ASCII or None, try the encoding from
  310. ``getdefaultlocale``. If that encoding was a "fallback" because Python
  311. could not figure it out from the environment or OS, encoding remains
  312. unresolved.
  313. 3. If the encoding is resolved, then make sure Python actually implements
  314. the encoding.
  315. 4. On the event of an error or unknown codec, revert to fallbacks
  316. (UTF-8 on Darwin, ASCII on everything else).
  317. 5. On the encoding is 'mac-roman' on Darwin, use UTF-8 as 'mac-roman' was
  318. a bug on older Python releases.
  319. On a side note, it would seem that the encoding only matters for when SVN
  320. does not yet support ``--xml`` and when getting repository and svn version
  321. numbers. The ``--xml`` technique should yield UTF-8 according to some
  322. messages on the SVN mailing lists. So if the version numbers are always
  323. 7-bit ASCII clean, it may be best to only support the file parsing methods
  324. for legacy SVN releases and support for SVN without the subprocess command
  325. would simple go away as support for the older SVNs does.
  326. ---
  327. 1.4
  328. ---
  329. * `Issue #27 <https://bitbucket.org/pypa/setuptools/issue/27>`_: ``easy_install`` will now use credentials from .pypirc if
  330. present for connecting to the package index.
  331. * `Pull Request #21 <https://bitbucket.org/pypa/setuptools/pull-request/21>`_: Omit unwanted newlines in ``package_index._encode_auth``
  332. when the username/password pair length indicates wrapping.
  333. -----
  334. 1.3.2
  335. -----
  336. * `Issue #99 <https://bitbucket.org/pypa/setuptools/issue/99>`_: Fix filename encoding issues in SVN support.
  337. -----
  338. 1.3.1
  339. -----
  340. * Remove exuberant warning in SVN support when SVN is not used.
  341. ---
  342. 1.3
  343. ---
  344. * Address security vulnerability in SSL match_hostname check as reported in
  345. `Python #17997 <http://bugs.python.org/issue17997>`_.
  346. * Prefer `backports.ssl_match_hostname
  347. <https://pypi.python.org/pypi/backports.ssl_match_hostname>`_ for backport
  348. implementation if present.
  349. * Correct NameError in ``ssl_support`` module (``socket.error``).
  350. ---
  351. 1.2
  352. ---
  353. * `Issue #26 <https://bitbucket.org/pypa/setuptools/issue/26>`_: Add support for SVN 1.7. Special thanks to Philip Thiem for the
  354. contribution.
  355. * `Issue #93 <https://bitbucket.org/pypa/setuptools/issue/93>`_: Wheels are now distributed with every release. Note that as
  356. reported in `Issue #108 <https://bitbucket.org/pypa/setuptools/issue/108>`_, as of Pip 1.4, scripts aren't installed properly
  357. from wheels. Therefore, if using Pip to install setuptools from a wheel,
  358. the ``easy_install`` command will not be available.
  359. * Setuptools "natural" launcher support, introduced in 1.0, is now officially
  360. supported.
  361. -----
  362. 1.1.7
  363. -----
  364. * Fixed behavior of NameError handling in 'script template (dev).py' (script
  365. launcher for 'develop' installs).
  366. * ``ez_setup.py`` now ensures partial downloads are cleaned up following
  367. a failed download.
  368. * `Distribute #363 <https://bitbucket.org/tarek/distribute/issue/363>`_ and `Issue #55 <https://bitbucket.org/pypa/setuptools/issue/55>`_: Skip an sdist test that fails on locales
  369. other than UTF-8.
  370. -----
  371. 1.1.6
  372. -----
  373. * `Distribute #349 <https://bitbucket.org/tarek/distribute/issue/349>`_: ``sandbox.execfile`` now opens the target file in binary
  374. mode, thus honoring a BOM in the file when compiled.
  375. -----
  376. 1.1.5
  377. -----
  378. * `Issue #69 <https://bitbucket.org/pypa/setuptools/issue/69>`_: Second attempt at fix (logic was reversed).
  379. -----
  380. 1.1.4
  381. -----
  382. * `Issue #77 <https://bitbucket.org/pypa/setuptools/issue/77>`_: Fix error in upload command (Python 2.4).
  383. -----
  384. 1.1.3
  385. -----
  386. * Fix NameError in previous patch.
  387. -----
  388. 1.1.2
  389. -----
  390. * `Issue #69 <https://bitbucket.org/pypa/setuptools/issue/69>`_: Correct issue where 404 errors are returned for URLs with
  391. fragments in them (such as #egg=).
  392. -----
  393. 1.1.1
  394. -----
  395. * `Issue #75 <https://bitbucket.org/pypa/setuptools/issue/75>`_: Add ``--insecure`` option to ez_setup.py to accommodate
  396. environments where a trusted SSL connection cannot be validated.
  397. * `Issue #76 <https://bitbucket.org/pypa/setuptools/issue/76>`_: Fix AttributeError in upload command with Python 2.4.
  398. ---
  399. 1.1
  400. ---
  401. * `Issue #71 <https://bitbucket.org/pypa/setuptools/issue/71>`_ (`Distribute #333 <https://bitbucket.org/tarek/distribute/issue/333>`_): EasyInstall now puts less emphasis on the
  402. condition when a host is blocked via ``--allow-hosts``.
  403. * `Issue #72 <https://bitbucket.org/pypa/setuptools/issue/72>`_: Restored Python 2.4 compatibility in ``ez_setup.py``.
  404. ---
  405. 1.0
  406. ---
  407. * `Issue #60 <https://bitbucket.org/pypa/setuptools/issue/60>`_: On Windows, Setuptools supports deferring to another launcher,
  408. such as Vinay Sajip's `pylauncher <https://bitbucket.org/pypa/pylauncher>`_
  409. (included with Python 3.3) to launch console and GUI scripts and not install
  410. its own launcher executables. This experimental functionality is currently
  411. only enabled if the ``SETUPTOOLS_LAUNCHER`` environment variable is set to
  412. "natural". In the future, this behavior may become default, but only after
  413. it has matured and seen substantial adoption. The ``SETUPTOOLS_LAUNCHER``
  414. also accepts "executable" to force the default behavior of creating launcher
  415. executables.
  416. * `Issue #63 <https://bitbucket.org/pypa/setuptools/issue/63>`_: Bootstrap script (ez_setup.py) now prefers Powershell, curl, or
  417. wget for retrieving the Setuptools tarball for improved security of the
  418. install. The script will still fall back to a simple ``urlopen`` on
  419. platforms that do not have these tools.
  420. * `Issue #65 <https://bitbucket.org/pypa/setuptools/issue/65>`_: Deprecated the ``Features`` functionality.
  421. * `Issue #52 <https://bitbucket.org/pypa/setuptools/issue/52>`_: In ``VerifyingHTTPSConn``, handle a tunnelled (proxied)
  422. connection.
  423. Backward-Incompatible Changes
  424. =============================
  425. This release includes a couple of backward-incompatible changes, but most if
  426. not all users will find 1.0 a drop-in replacement for 0.9.
  427. * `Issue #50 <https://bitbucket.org/pypa/setuptools/issue/50>`_: Normalized API of environment marker support. Specifically,
  428. removed line number and filename from SyntaxErrors when returned from
  429. `pkg_resources.invalid_marker`. Any clients depending on the specific
  430. string representation of exceptions returned by that function may need to
  431. be updated to account for this change.
  432. * `Issue #50 <https://bitbucket.org/pypa/setuptools/issue/50>`_: SyntaxErrors generated by `pkg_resources.invalid_marker` are
  433. normalized for cross-implementation consistency.
  434. * Removed ``--ignore-conflicts-at-my-risk`` and ``--delete-conflicting``
  435. options to easy_install. These options have been deprecated since 0.6a11.
  436. -----
  437. 0.9.8
  438. -----
  439. * `Issue #53 <https://bitbucket.org/pypa/setuptools/issue/53>`_: Fix NameErrors in `_vcs_split_rev_from_url`.
  440. -----
  441. 0.9.7
  442. -----
  443. * `Issue #49 <https://bitbucket.org/pypa/setuptools/issue/49>`_: Correct AttributeError on PyPy where a hashlib.HASH object does
  444. not have a `.name` attribute.
  445. * `Issue #34 <https://bitbucket.org/pypa/setuptools/issue/34>`_: Documentation now refers to bootstrap script in code repository
  446. referenced by bookmark.
  447. * Add underscore-separated keys to environment markers (markerlib).
  448. -----
  449. 0.9.6
  450. -----
  451. * `Issue #44 <https://bitbucket.org/pypa/setuptools/issue/44>`_: Test failure on Python 2.4 when MD5 hash doesn't have a `.name`
  452. attribute.
  453. -----
  454. 0.9.5
  455. -----
  456. * `Python #17980 <http://bugs.python.org/issue17980>`_: Fix security vulnerability in SSL certificate validation.
  457. -----
  458. 0.9.4
  459. -----
  460. * `Issue #43 <https://bitbucket.org/pypa/setuptools/issue/43>`_: Fix issue (introduced in 0.9.1) with version resolution when
  461. upgrading over other releases of Setuptools.
  462. -----
  463. 0.9.3
  464. -----
  465. * `Issue #42 <https://bitbucket.org/pypa/setuptools/issue/42>`_: Fix new ``AttributeError`` introduced in last fix.
  466. -----
  467. 0.9.2
  468. -----
  469. * `Issue #42 <https://bitbucket.org/pypa/setuptools/issue/42>`_: Fix regression where blank checksums would trigger an
  470. ``AttributeError``.
  471. -----
  472. 0.9.1
  473. -----
  474. * `Distribute #386 <https://bitbucket.org/tarek/distribute/issue/386>`_: Allow other positional and keyword arguments to os.open.
  475. * Corrected dependency on certifi mis-referenced in 0.9.
  476. ---
  477. 0.9
  478. ---
  479. * `package_index` now validates hashes other than MD5 in download links.
  480. ---
  481. 0.8
  482. ---
  483. * Code base now runs on Python 2.4 - Python 3.3 without Python 2to3
  484. conversion.
  485. -----
  486. 0.7.8
  487. -----
  488. * `Distribute #375 <https://bitbucket.org/tarek/distribute/issue/375>`_: Yet another fix for yet another regression.
  489. -----
  490. 0.7.7
  491. -----
  492. * `Distribute #375 <https://bitbucket.org/tarek/distribute/issue/375>`_: Repair AttributeError created in last release (redo).
  493. * `Issue #30 <https://bitbucket.org/pypa/setuptools/issue/30>`_: Added test for get_cache_path.
  494. -----
  495. 0.7.6
  496. -----
  497. * `Distribute #375 <https://bitbucket.org/tarek/distribute/issue/375>`_: Repair AttributeError created in last release.
  498. -----
  499. 0.7.5
  500. -----
  501. * `Issue #21 <https://bitbucket.org/pypa/setuptools/issue/21>`_: Restore Python 2.4 compatibility in ``test_easy_install``.
  502. * `Distribute #375 <https://bitbucket.org/tarek/distribute/issue/375>`_: Merged additional warning from Distribute 0.6.46.
  503. * Now honor the environment variable
  504. ``SETUPTOOLS_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT`` in addition to the now
  505. deprecated ``DISTRIBUTE_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT``.
  506. -----
  507. 0.7.4
  508. -----
  509. * `Issue #20 <https://bitbucket.org/pypa/setuptools/issue/20>`_: Fix comparison of parsed SVN version on Python 3.
  510. -----
  511. 0.7.3
  512. -----
  513. * `Issue #1 <https://bitbucket.org/pypa/setuptools/issue/1>`_: Disable installation of Windows-specific files on non-Windows systems.
  514. * Use new sysconfig module with Python 2.7 or >=3.2.
  515. -----
  516. 0.7.2
  517. -----
  518. * `Issue #14 <https://bitbucket.org/pypa/setuptools/issue/14>`_: Use markerlib when the `parser` module is not available.
  519. * `Issue #10 <https://bitbucket.org/pypa/setuptools/issue/10>`_: ``ez_setup.py`` now uses HTTPS to download setuptools from PyPI.
  520. -----
  521. 0.7.1
  522. -----
  523. * Fix NameError (`Issue #3 <https://bitbucket.org/pypa/setuptools/issue/3>`_) again - broken in bad merge.
  524. ---
  525. 0.7
  526. ---
  527. * Merged Setuptools and Distribute. See docs/merge.txt for details.
  528. Added several features that were slated for setuptools 0.6c12:
  529. * Index URL now defaults to HTTPS.
  530. * Added experimental environment marker support. Now clients may designate a
  531. PEP-426 environment marker for "extra" dependencies. Setuptools uses this
  532. feature in ``setup.py`` for optional SSL and certificate validation support
  533. on older platforms. Based on Distutils-SIG discussions, the syntax is
  534. somewhat tentative. There should probably be a PEP with a firmer spec before
  535. the feature should be considered suitable for use.
  536. * Added support for SSL certificate validation when installing packages from
  537. an HTTPS service.
  538. -----
  539. 0.7b4
  540. -----
  541. * `Issue #3 <https://bitbucket.org/pypa/setuptools/issue/3>`_: Fixed NameError in SSL support.
  542. ------
  543. 0.6.49
  544. ------
  545. * Move warning check in ``get_cache_path`` to follow the directory creation
  546. to avoid errors when the cache path does not yet exist. Fixes the error
  547. reported in `Distribute #375 <https://bitbucket.org/tarek/distribute/issue/375>`_.
  548. ------
  549. 0.6.48
  550. ------
  551. * Correct AttributeError in ``ResourceManager.get_cache_path`` introduced in
  552. 0.6.46 (redo).
  553. ------
  554. 0.6.47
  555. ------
  556. * Correct AttributeError in ``ResourceManager.get_cache_path`` introduced in
  557. 0.6.46.
  558. ------
  559. 0.6.46
  560. ------
  561. * `Distribute #375 <https://bitbucket.org/tarek/distribute/issue/375>`_: Issue a warning if the PYTHON_EGG_CACHE or otherwise
  562. customized egg cache location specifies a directory that's group- or
  563. world-writable.
  564. ------
  565. 0.6.45
  566. ------
  567. * `Distribute #379 <https://bitbucket.org/tarek/distribute/issue/379>`_: ``distribute_setup.py`` now traps VersionConflict as well,
  568. restoring ability to upgrade from an older setuptools version.
  569. ------
  570. 0.6.44
  571. ------
  572. * ``distribute_setup.py`` has been updated to allow Setuptools 0.7 to
  573. satisfy use_setuptools.
  574. ------
  575. 0.6.43
  576. ------
  577. * `Distribute #378 <https://bitbucket.org/tarek/distribute/issue/378>`_: Restore support for Python 2.4 Syntax (regression in 0.6.42).
  578. ------
  579. 0.6.42
  580. ------
  581. * External links finder no longer yields duplicate links.
  582. * `Distribute #337 <https://bitbucket.org/tarek/distribute/issue/337>`_: Moved site.py to setuptools/site-patch.py (graft of very old
  583. patch from setuptools trunk which inspired PR `#31 <https://bitbucket.org/pypa/setuptools/issue/31>`_).
  584. ------
  585. 0.6.41
  586. ------
  587. * `Distribute #27 <https://bitbucket.org/tarek/distribute/issue/27>`_: Use public api for loading resources from zip files rather than
  588. the private method `_zip_directory_cache`.
  589. * Added a new function ``easy_install.get_win_launcher`` which may be used by
  590. third-party libraries such as buildout to get a suitable script launcher.
  591. ------
  592. 0.6.40
  593. ------
  594. * `Distribute #376 <https://bitbucket.org/tarek/distribute/issue/376>`_: brought back cli.exe and gui.exe that were deleted in the
  595. previous release.
  596. ------
  597. 0.6.39
  598. ------
  599. * Add support for console launchers on ARM platforms.
  600. * Fix possible issue in GUI launchers where the subsystem was not supplied to
  601. the linker.
  602. * Launcher build script now refactored for robustness.
  603. * `Distribute #375 <https://bitbucket.org/tarek/distribute/issue/375>`_: Resources extracted from a zip egg to the file system now also
  604. check the contents of the file against the zip contents during each
  605. invocation of get_resource_filename.
  606. ------
  607. 0.6.38
  608. ------
  609. * `Distribute #371 <https://bitbucket.org/tarek/distribute/issue/371>`_: The launcher manifest file is now installed properly.
  610. ------
  611. 0.6.37
  612. ------
  613. * `Distribute #143 <https://bitbucket.org/tarek/distribute/issue/143>`_: Launcher scripts, including easy_install itself, are now
  614. accompanied by a manifest on 32-bit Windows environments to avoid the
  615. Installer Detection Technology and thus undesirable UAC elevation described
  616. in `this Microsoft article
  617. <http://technet.microsoft.com/en-us/library/cc709628%28WS.10%29.aspx>`_.
  618. ------
  619. 0.6.36
  620. ------
  621. * `Pull Request #35 <https://bitbucket.org/pypa/setuptools/pull-request/35>`_: In `Buildout #64 <https://github.com/buildout/buildout/issues/64>`_, it was reported that
  622. under Python 3, installation of distutils scripts could attempt to copy
  623. the ``__pycache__`` directory as a file, causing an error, apparently only
  624. under Windows. Easy_install now skips all directories when processing
  625. metadata scripts.
  626. ------
  627. 0.6.35
  628. ------
  629. Note this release is backward-incompatible with distribute 0.6.23-0.6.34 in
  630. how it parses version numbers.
  631. * `Distribute #278 <https://bitbucket.org/tarek/distribute/issue/278>`_: Restored compatibility with distribute 0.6.22 and setuptools
  632. 0.6. Updated the documentation to match more closely with the version
  633. parsing as intended in setuptools 0.6.
  634. ------
  635. 0.6.34
  636. ------
  637. * `Distribute #341 <https://bitbucket.org/tarek/distribute/issue/341>`_: 0.6.33 fails to build under Python 2.4.
  638. ------
  639. 0.6.33
  640. ------
  641. * Fix 2 errors with Jython 2.5.
  642. * Fix 1 failure with Jython 2.5 and 2.7.
  643. * Disable workaround for Jython scripts on Linux systems.
  644. * `Distribute #336 <https://bitbucket.org/tarek/distribute/issue/336>`_: `setup.py` no longer masks failure exit code when tests fail.
  645. * Fix issue in pkg_resources where try/except around a platform-dependent
  646. import would trigger hook load failures on Mercurial. See pull request 32
  647. for details.
  648. * `Distribute #341 <https://bitbucket.org/tarek/distribute/issue/341>`_: Fix a ResourceWarning.
  649. ------
  650. 0.6.32
  651. ------
  652. * Fix test suite with Python 2.6.
  653. * Fix some DeprecationWarnings and ResourceWarnings.
  654. * `Distribute #335 <https://bitbucket.org/tarek/distribute/issue/335>`_: Backed out `setup_requires` superceding installed requirements
  655. until regression can be addressed.
  656. ------
  657. 0.6.31
  658. ------
  659. * `Distribute #303 <https://bitbucket.org/tarek/distribute/issue/303>`_: Make sure the manifest only ever contains UTF-8 in Python 3.
  660. * `Distribute #329 <https://bitbucket.org/tarek/distribute/issue/329>`_: Properly close files created by tests for compatibility with
  661. Jython.
  662. * Work around `Jython #1980 <http://bugs.jython.org/issue1980>`_ and `Jython #1981 <http://bugs.jython.org/issue1981>`_.
  663. * `Distribute #334 <https://bitbucket.org/tarek/distribute/issue/334>`_: Provide workaround for packages that reference `sys.__stdout__`
  664. such as numpy does. This change should address
  665. `virtualenv `#359 <https://bitbucket.org/pypa/setuptools/issue/359>`_ <https://github.com/pypa/virtualenv/issues/359>`_ as long
  666. as the system encoding is UTF-8 or the IO encoding is specified in the
  667. environment, i.e.::
  668. PYTHONIOENCODING=utf8 pip install numpy
  669. * Fix for encoding issue when installing from Windows executable on Python 3.
  670. * `Distribute #323 <https://bitbucket.org/tarek/distribute/issue/323>`_: Allow `setup_requires` requirements to supercede installed
  671. requirements. Added some new keyword arguments to existing pkg_resources
  672. methods. Also had to updated how __path__ is handled for namespace packages
  673. to ensure that when a new egg distribution containing a namespace package is
  674. placed on sys.path, the entries in __path__ are found in the same order they
  675. would have been in had that egg been on the path when pkg_resources was
  676. first imported.
  677. ------
  678. 0.6.30
  679. ------
  680. * `Distribute #328 <https://bitbucket.org/tarek/distribute/issue/328>`_: Clean up temporary directories in distribute_setup.py.
  681. * Fix fatal bug in distribute_setup.py.
  682. ------
  683. 0.6.29
  684. ------
  685. * `Pull Request #14 <https://bitbucket.org/pypa/setuptools/pull-request/14>`_: Honor file permissions in zip files.
  686. * `Distribute #327 <https://bitbucket.org/tarek/distribute/issue/327>`_: Merged pull request `#24 <https://bitbucket.org/pypa/setuptools/issue/24>`_ to fix a dependency problem with pip.
  687. * Merged pull request `#23 <https://bitbucket.org/pypa/setuptools/issue/23>`_ to fix https://github.com/pypa/virtualenv/issues/301.
  688. * If Sphinx is installed, the `upload_docs` command now runs `build_sphinx`
  689. to produce uploadable documentation.
  690. * `Distribute #326 <https://bitbucket.org/tarek/distribute/issue/326>`_: `upload_docs` provided mangled auth credentials under Python 3.
  691. * `Distribute #320 <https://bitbucket.org/tarek/distribute/issue/320>`_: Fix check for "createable" in distribute_setup.py.
  692. * `Distribute #305 <https://bitbucket.org/tarek/distribute/issue/305>`_: Remove a warning that was triggered during normal operations.
  693. * `Distribute #311 <https://bitbucket.org/tarek/distribute/issue/311>`_: Print metadata in UTF-8 independent of platform.
  694. * `Distribute #303 <https://bitbucket.org/tarek/distribute/issue/303>`_: Read manifest file with UTF-8 encoding under Python 3.
  695. * `Distribute #301 <https://bitbucket.org/tarek/distribute/issue/301>`_: Allow to run tests of namespace packages when using 2to3.
  696. * `Distribute #304 <https://bitbucket.org/tarek/distribute/issue/304>`_: Prevent import loop in site.py under Python 3.3.
  697. * `Distribute #283 <https://bitbucket.org/tarek/distribute/issue/283>`_: Reenable scanning of `*.pyc` / `*.pyo` files on Python 3.3.
  698. * `Distribute #299 <https://bitbucket.org/tarek/distribute/issue/299>`_: The develop command didn't work on Python 3, when using 2to3,
  699. as the egg link would go to the Python 2 source. Linking to the 2to3'd code
  700. in build/lib makes it work, although you will have to rebuild the module
  701. before testing it.
  702. * `Distribute #306 <https://bitbucket.org/tarek/distribute/issue/306>`_: Even if 2to3 is used, we build in-place under Python 2.
  703. * `Distribute #307 <https://bitbucket.org/tarek/distribute/issue/307>`_: Prints the full path when .svn/entries is broken.
  704. * `Distribute #313 <https://bitbucket.org/tarek/distribute/issue/313>`_: Support for sdist subcommands (Python 2.7)
  705. * `Distribute #314 <https://bitbucket.org/tarek/distribute/issue/314>`_: test_local_index() would fail an OS X.
  706. * `Distribute #310 <https://bitbucket.org/tarek/distribute/issue/310>`_: Non-ascii characters in a namespace __init__.py causes errors.
  707. * `Distribute #218 <https://bitbucket.org/tarek/distribute/issue/218>`_: Improved documentation on behavior of `package_data` and
  708. `include_package_data`. Files indicated by `package_data` are now included
  709. in the manifest.
  710. * `distribute_setup.py` now allows a `--download-base` argument for retrieving
  711. distribute from a specified location.
  712. ------
  713. 0.6.28
  714. ------
  715. * `Distribute #294 <https://bitbucket.org/tarek/distribute/issue/294>`_: setup.py can now be invoked from any directory.
  716. * Scripts are now installed honoring the umask.
  717. * Added support for .dist-info directories.
  718. * `Distribute #283 <https://bitbucket.org/tarek/distribute/issue/283>`_: Fix and disable scanning of `*.pyc` / `*.pyo` files on
  719. Python 3.3.
  720. ------
  721. 0.6.27
  722. ------
  723. * Support current snapshots of CPython 3.3.
  724. * Distribute now recognizes README.rst as a standard, default readme file.
  725. * Exclude 'encodings' modules when removing modules from sys.modules.
  726. Workaround for `#285 <https://bitbucket.org/pypa/setuptools/issue/285>`_.
  727. * `Distribute #231 <https://bitbucket.org/tarek/distribute/issue/231>`_: Don't fiddle with system python when used with buildout
  728. (bootstrap.py)
  729. ------
  730. 0.6.26
  731. ------
  732. * `Distribute #183 <https://bitbucket.org/tarek/distribute/issue/183>`_: Symlinked files are now extracted from source distributions.
  733. * `Distribute #227 <https://bitbucket.org/tarek/distribute/issue/227>`_: Easy_install fetch parameters are now passed during the
  734. installation of a source distribution; now fulfillment of setup_requires
  735. dependencies will honor the parameters passed to easy_install.
  736. ------
  737. 0.6.25
  738. ------
  739. * `Distribute #258 <https://bitbucket.org/tarek/distribute/issue/258>`_: Workaround a cache issue
  740. * `Distribute #260 <https://bitbucket.org/tarek/distribute/issue/260>`_: distribute_setup.py now accepts the --user parameter for
  741. Python 2.6 and later.
  742. * `Distribute #262 <https://bitbucket.org/tarek/distribute/issue/262>`_: package_index.open_with_auth no longer throws LookupError
  743. on Python 3.
  744. * `Distribute #269 <https://bitbucket.org/tarek/distribute/issue/269>`_: AttributeError when an exception occurs reading Manifest.in
  745. on late releases of Python.
  746. * `Distribute #272 <https://bitbucket.org/tarek/distribute/issue/272>`_: Prevent TypeError when namespace package names are unicode
  747. and single-install-externally-managed is used. Also fixes PIP issue
  748. 449.
  749. * `Distribute #273 <https://bitbucket.org/tarek/distribute/issue/273>`_: Legacy script launchers now install with Python2/3 support.
  750. ------
  751. 0.6.24
  752. ------
  753. * `Distribute #249 <https://bitbucket.org/tarek/distribute/issue/249>`_: Added options to exclude 2to3 fixers
  754. ------
  755. 0.6.23
  756. ------
  757. * `Distribute #244 <https://bitbucket.org/tarek/distribute/issue/244>`_: Fixed a test
  758. * `Distribute #243 <https://bitbucket.org/tarek/distribute/issue/243>`_: Fixed a test
  759. * `Distribute #239 <https://bitbucket.org/tarek/distribute/issue/239>`_: Fixed a test
  760. * `Distribute #240 <https://bitbucket.org/tarek/distribute/issue/240>`_: Fixed a test
  761. * `Distribute #241 <https://bitbucket.org/tarek/distribute/issue/241>`_: Fixed a test
  762. * `Distribute #237 <https://bitbucket.org/tarek/distribute/issue/237>`_: Fixed a test
  763. * `Distribute #238 <https://bitbucket.org/tarek/distribute/issue/238>`_: easy_install now uses 64bit executable wrappers on 64bit Python
  764. * `Distribute #208 <https://bitbucket.org/tarek/distribute/issue/208>`_: Fixed parsed_versions, it now honors post-releases as noted in the documentation
  765. * `Distribute #207 <https://bitbucket.org/tarek/distribute/issue/207>`_: Windows cli and gui wrappers pass CTRL-C to child python process
  766. * `Distribute #227 <https://bitbucket.org/tarek/distribute/issue/227>`_: easy_install now passes its arguments to setup.py bdist_egg
  767. * `Distribute #225 <https://bitbucket.org/tarek/distribute/issue/225>`_: Fixed a NameError on Python 2.5, 2.4
  768. ------
  769. 0.6.21
  770. ------
  771. * `Distribute #225 <https://bitbucket.org/tarek/distribute/issue/225>`_: FIxed a regression on py2.4
  772. ------
  773. 0.6.20
  774. ------
  775. * `Distribute #135 <https://bitbucket.org/tarek/distribute/issue/135>`_: Include url in warning when processing URLs in package_index.
  776. * `Distribute #212 <https://bitbucket.org/tarek/distribute/issue/212>`_: Fix issue where easy_instal fails on Python 3 on windows installer.
  777. * `Distribute #213 <https://bitbucket.org/tarek/distribute/issue/213>`_: Fix typo in documentation.
  778. ------
  779. 0.6.19
  780. ------
  781. * `Distribute #206 <https://bitbucket.org/tarek/distribute/issue/206>`_: AttributeError: 'HTTPMessage' object has no attribute 'getheaders'
  782. ------
  783. 0.6.18
  784. ------
  785. * `Distribute #210 <https://bitbucket.org/tarek/distribute/issue/210>`_: Fixed a regression introduced by `Distribute #204 <https://bitbucket.org/tarek/distribute/issue/204>`_ fix.
  786. ------
  787. 0.6.17
  788. ------
  789. * Support 'DISTRIBUTE_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT' environment
  790. variable to allow to disable installation of easy_install-${version} script.
  791. * Support Python >=3.1.4 and >=3.2.1.
  792. * `Distribute #204 <https://bitbucket.org/tarek/distribute/issue/204>`_: Don't try to import the parent of a namespace package in
  793. declare_namespace
  794. * `Distribute #196 <https://bitbucket.org/tarek/distribute/issue/196>`_: Tolerate responses with multiple Content-Length headers
  795. * `Distribute #205 <https://bitbucket.org/tarek/distribute/issue/205>`_: Sandboxing doesn't preserve working_set. Leads to setup_requires
  796. problems.
  797. ------
  798. 0.6.16
  799. ------
  800. * Builds sdist gztar even on Windows (avoiding `Distribute #193 <https://bitbucket.org/tarek/distribute/issue/193>`_).
  801. * `Distribute #192 <https://bitbucket.org/tarek/distribute/issue/192>`_: Fixed metadata omitted on Windows when package_dir
  802. specified with forward-slash.
  803. * `Distribute #195 <https://bitbucket.org/tarek/distribute/issue/195>`_: Cython build support.
  804. * `Distribute #200 <https://bitbucket.org/tarek/distribute/issue/200>`_: Issues with recognizing 64-bit packages on Windows.
  805. ------
  806. 0.6.15
  807. ------
  808. * Fixed typo in bdist_egg
  809. * Several issues under Python 3 has been solved.
  810. * `Distribute #146 <https://bitbucket.org/tarek/distribute/issue/146>`_: Fixed missing DLL files after easy_install of windows exe package.
  811. ------
  812. 0.6.14
  813. ------
  814. * `Distribute #170 <https://bitbucket.org/tarek/distribute/issue/170>`_: Fixed unittest failure. Thanks to Toshio.
  815. * `Distribute #171 <https://bitbucket.org/tarek/distribute/issue/171>`_: Fixed race condition in unittests cause deadlocks in test suite.
  816. * `Distribute #143 <https://bitbucket.org/tarek/distribute/issue/143>`_: Fixed a lookup issue with easy_install.
  817. Thanks to David and Zooko.
  818. * `Distribute #174 <https://bitbucket.org/tarek/distribute/issue/174>`_: Fixed the edit mode when its used with setuptools itself
  819. ------
  820. 0.6.13
  821. ------
  822. * `Distribute #160 <https://bitbucket.org/tarek/distribute/issue/160>`_: 2.7 gives ValueError("Invalid IPv6 URL")
  823. * `Distribute #150 <https://bitbucket.org/tarek/distribute/issue/150>`_: Fixed using ~/.local even in a --no-site-packages virtualenv
  824. * `Distribute #163 <https://bitbucket.org/tarek/distribute/issue/163>`_: scan index links before external links, and don't use the md5 when
  825. comparing two distributions
  826. ------
  827. 0.6.12
  828. ------
  829. * `Distribute #149 <https://bitbucket.org/tarek/distribute/issue/149>`_: Fixed various failures on 2.3/2.4
  830. ------
  831. 0.6.11
  832. ------
  833. * Found another case of SandboxViolation - fixed
  834. * `Distribute #15 <https://bitbucket.org/tarek/distribute/issue/15>`_ and `Distribute #48 <https://bitbucket.org/tarek/distribute/issue/48>`_: Introduced a socket timeout of 15 seconds on url openings
  835. * Added indexsidebar.html into MANIFEST.in
  836. * `Distribute #108 <https://bitbucket.org/tarek/distribute/issue/108>`_: Fixed TypeError with Python3.1
  837. * `Distribute #121 <https://bitbucket.org/tarek/distribute/issue/121>`_: Fixed --help install command trying to actually install.
  838. * `Distribute #112 <https://bitbucket.org/tarek/distribute/issue/112>`_: Added an os.makedirs so that Tarek's solution will work.
  839. * `Distribute #133 <https://bitbucket.org/tarek/distribute/issue/133>`_: Added --no-find-links to easy_install
  840. * Added easy_install --user
  841. * `Distribute #100 <https://bitbucket.org/tarek/distribute/issue/100>`_: Fixed develop --user not taking '.' in PYTHONPATH into account
  842. * `Distribute #134 <https://bitbucket.org/tarek/distribute/issue/134>`_: removed spurious UserWarnings. Patch by VanLindberg
  843. * `Distribute #138 <https://bitbucket.org/tarek/distribute/issue/138>`_: cant_write_to_target error when setup_requires is used.
  844. * `Distribute #147 <https://bitbucket.org/tarek/distribute/issue/147>`_: respect the sys.dont_write_bytecode flag
  845. ------
  846. 0.6.10
  847. ------
  848. * Reverted change made for the DistributionNotFound exception because
  849. zc.buildout uses the exception message to get the name of the
  850. distribution.
  851. -----
  852. 0.6.9
  853. -----
  854. * `Distribute #90 <https://bitbucket.org/tarek/distribute/issue/90>`_: unknown setuptools version can be added in the working set
  855. * `Distribute #87 <https://bitbucket.org/tarek/distribute/issue/87>`_: setupt.py doesn't try to convert distribute_setup.py anymore
  856. Initial Patch by arfrever.
  857. * `Distribute #89 <https://bitbucket.org/tarek/distribute/issue/89>`_: added a side bar with a download link to the doc.
  858. * `Distribute #86 <https://bitbucket.org/tarek/distribute/issue/86>`_: fixed missing sentence in pkg_resources doc.
  859. * Added a nicer error message when a DistributionNotFound is raised.
  860. * `Distribute #80 <https://bitbucket.org/tarek/distribute/issue/80>`_: test_develop now works with Python 3.1
  861. * `Distribute #93 <https://bitbucket.org/tarek/distribute/issue/93>`_: upload_docs now works if there is an empty sub-directory.
  862. * `Distribute #70 <https://bitbucket.org/tarek/distribute/issue/70>`_: exec bit on non-exec files
  863. * `Distribute #99 <https://bitbucket.org/tarek/distribute/issue/99>`_: now the standalone easy_install command doesn't uses a
  864. "setup.cfg" if any exists in the working directory. It will use it
  865. only if triggered by ``install_requires`` from a setup.py call
  866. (install, develop, etc).
  867. * `Distribute #101 <https://bitbucket.org/tarek/distribute/issue/101>`_: Allowing ``os.devnull`` in Sandbox
  868. * `Distribute #92 <https://bitbucket.org/tarek/distribute/issue/92>`_: Fixed the "no eggs" found error with MacPort
  869. (platform.mac_ver() fails)
  870. * `Distribute #103 <https://bitbucket.org/tarek/distribute/issue/103>`_: test_get_script_header_jython_workaround not run
  871. anymore under py3 with C or POSIX local. Contributed by Arfrever.
  872. * `Distribute #104 <https://bitbucket.org/tarek/distribute/issue/104>`_: remvoved the assertion when the installation fails,
  873. with a nicer message for the end user.
  874. * `Distribute #100 <https://bitbucket.org/tarek/distribute/issue/100>`_: making sure there's no SandboxViolation when
  875. the setup script patches setuptools.
  876. -----
  877. 0.6.8
  878. -----
  879. * Added "check_packages" in dist. (added in Setuptools 0.6c11)
  880. * Fixed the DONT_PATCH_SETUPTOOLS state.
  881. -----
  882. 0.6.7
  883. -----
  884. * `Distribute #58 <https://bitbucket.org/tarek/distribute/issue/58>`_: Added --user support to the develop command
  885. * `Distribute #11 <https://bitbucket.org/tarek/distribute/issue/11>`_: Generated scripts now wrap their call to the script entry point
  886. in the standard "if name == 'main'"
  887. * Added the 'DONT_PATCH_SETUPTOOLS' environment variable, so virtualenv
  888. can drive an installation that doesn't patch a global setuptools.
  889. * Reviewed unladen-swallow specific change from
  890. http://code.google.com/p/unladen-swallow/source/detail?spec=svn875&r=719
  891. and determined that it no longer applies. Distribute should work fine with
  892. Unladen Swallow 2009Q3.
  893. * `Distribute #21 <https://bitbucket.org/tarek/distribute/issue/21>`_: Allow PackageIndex.open_url to gracefully handle all cases of a
  894. httplib.HTTPException instead of just InvalidURL and BadStatusLine.
  895. * Removed virtual-python.py from this distribution and updated documentation
  896. to point to the actively maintained virtualenv instead.
  897. * `Distribute #64 <https://bitbucket.org/tarek/distribute/issue/64>`_: use_setuptools no longer rebuilds the distribute egg every
  898. time it is run
  899. * use_setuptools now properly respects the requested version
  900. * use_setuptools will no longer try to import a distribute egg for the
  901. wrong Python version
  902. * `Distribute #74 <https://bitbucket.org/tarek/distribute/issue/74>`_: no_fake should be True by default.
  903. * `Distribute #72 <https://bitbucket.org/tarek/distribute/issue/72>`_: avoid a bootstrapping issue with easy_install -U
  904. -----
  905. 0.6.6
  906. -----
  907. * Unified the bootstrap file so it works on both py2.x and py3k without 2to3
  908. (patch by Holger Krekel)
  909. -----
  910. 0.6.5
  911. -----
  912. * `Distribute #65 <https://bitbucket.org/tarek/distribute/issue/65>`_: cli.exe and gui.exe are now generated at build time,
  913. depending on the platform in use.
  914. * `Distribute #67 <https://bitbucket.org/tarek/distribute/issue/67>`_: Fixed doc typo (PEP 381/382)
  915. * Distribute no longer shadows setuptools if we require a 0.7-series
  916. setuptools. And an error is raised when installing a 0.7 setuptools with
  917. distribute.
  918. * When run from within buildout, no attempt is made to modify an existing
  919. setuptools egg, whether in a shared egg directory or a system setuptools.
  920. * Fixed a hole in sandboxing allowing builtin file to write outside of
  921. the sandbox.
  922. -----
  923. 0.6.4
  924. -----
  925. * Added the generation of `distribute_setup_3k.py` during the release.
  926. This closes `Distribute #52 <https://bitbucket.org/tarek/distribute/issue/52>`_.
  927. * Added an upload_docs command to easily upload project documentation to
  928. PyPI's https://pythonhosted.org. This close issue `Distribute #56 <https://bitbucket.org/tarek/distribute/issue/56>`_.
  929. * Fixed a bootstrap bug on the use_setuptools() API.
  930. -----
  931. 0.6.3
  932. -----
  933. setuptools
  934. ==========
  935. * Fixed a bunch of calls to file() that caused crashes on Python 3.
  936. bootstrapping
  937. =============
  938. * Fixed a bug in sorting that caused bootstrap to fail on Python 3.
  939. -----
  940. 0.6.2
  941. -----
  942. setuptools
  943. ==========
  944. * Added Python 3 support; see docs/python3.txt.
  945. This closes `Old Setuptools #39 <http://bugs.python.org/setuptools/issue39>`_.
  946. * Added option to run 2to3 automatically when installing on Python 3.
  947. This closes issue `Distribute #31 <https://bitbucket.org/tarek/distribute/issue/31>`_.
  948. * Fixed invalid usage of requirement.parse, that broke develop -d.
  949. This closes `Old Setuptools #44 <http://bugs.python.org/setuptools/issue44>`_.
  950. * Fixed script launcher for 64-bit Windows.
  951. This closes `Old Setuptools #2 <http://bugs.python.org/setuptools/issue2>`_.
  952. * KeyError when compiling extensions.
  953. This closes `Old Setuptools #41 <http://bugs.python.org/setuptools/issue41>`_.
  954. bootstrapping
  955. =============
  956. * Fixed bootstrap not working on Windows. This closes issue `Distribute #49 <https://bitbucket.org/tarek/distribute/issue/49>`_.
  957. * Fixed 2.6 dependencies. This closes issue `Distribute #50 <https://bitbucket.org/tarek/distribute/issue/50>`_.
  958. * Make sure setuptools is patched when running through easy_install
  959. This closes `Old Setuptools #40 <http://bugs.python.org/setuptools/issue40>`_.
  960. -----
  961. 0.6.1
  962. -----
  963. setuptools
  964. ==========
  965. * package_index.urlopen now catches BadStatusLine and malformed url errors.
  966. This closes `Distribute #16 <https://bitbucket.org/tarek/distribute/issue/16>`_ and `Distribute #18 <https://bitbucket.org/tarek/distribute/issue/18>`_.
  967. * zip_ok is now False by default. This closes `Old Setuptools #33 <http://bugs.python.org/setuptools/issue33>`_.
  968. * Fixed invalid URL error catching. `Old Setuptools #20 <http://bugs.python.org/setuptools/issue20>`_.
  969. * Fixed invalid bootstraping with easy_install installation (`Distribute #40 <https://bitbucket.org/tarek/distribute/issue/40>`_).
  970. Thanks to Florian Schulze for the help.
  971. * Removed buildout/bootstrap.py. A new repository will create a specific
  972. bootstrap.py script.
  973. bootstrapping
  974. =============
  975. * The boostrap process leave setuptools alone if detected in the system
  976. and --root or --prefix is provided, but is not in the same location.
  977. This closes `Distribute #10 <https://bitbucket.org/tarek/distribute/issue/10>`_.
  978. ---
  979. 0.6
  980. ---
  981. setuptools
  982. ==========
  983. * Packages required at build time where not fully present at install time.
  984. This closes `Distribute #12 <https://bitbucket.org/tarek/distribute/issue/12>`_.
  985. * Protected against failures in tarfile extraction. This closes `Distribute #10 <https://bitbucket.org/tarek/distribute/issue/10>`_.
  986. * Made Jython api_tests.txt doctest compatible. This closes `Distribute #7 <https://bitbucket.org/tarek/distribute/issue/7>`_.
  987. * sandbox.py replaced builtin type file with builtin function open. This
  988. closes `Distribute #6 <https://bitbucket.org/tarek/distribute/issue/6>`_.
  989. * Immediately close all file handles. This closes `Distribute #3 <https://bitbucket.org/tarek/distribute/issue/3>`_.
  990. * Added compatibility with Subversion 1.6. This references `Distribute #1 <https://bitbucket.org/tarek/distribute/issue/1>`_.
  991. pkg_resources
  992. =============
  993. * Avoid a call to /usr/bin/sw_vers on OSX and use the official platform API
  994. instead. Based on a patch from ronaldoussoren. This closes issue `#5 <https://bitbucket.org/pypa/setuptools/issue/5>`_.
  995. * Fixed a SandboxViolation for mkdir that could occur in certain cases.
  996. This closes `Distribute #13 <https://bitbucket.org/tarek/distribute/issue/13>`_.
  997. * Allow to find_on_path on systems with tight permissions to fail gracefully.
  998. This closes `Distribute #9 <https://bitbucket.org/tarek/distribute/issue/9>`_.
  999. * Corrected inconsistency between documentation and code of add_entry.
  1000. This closes `Distribute #8 <https://bitbucket.org/tarek/distribute/issue/8>`_.
  1001. * Immediately close all file handles. This closes `Distribute #3 <https://bitbucket.org/tarek/distribute/issue/3>`_.
  1002. easy_install
  1003. ============
  1004. * Immediately close all file handles. This closes `Distribute #3 <https://bitbucket.org/tarek/distribute/issue/3>`_.
  1005. -----
  1006. 0.6c9
  1007. -----
  1008. * Fixed a missing files problem when using Windows source distributions on
  1009. non-Windows platforms, due to distutils not handling manifest file line
  1010. endings correctly.
  1011. * Updated Pyrex support to work with Pyrex 0.9.6 and higher.
  1012. * Minor changes for Jython compatibility, including skipping tests that can't
  1013. work on Jython.
  1014. * Fixed not installing eggs in ``install_requires`` if they were also used for
  1015. ``setup_requires`` or ``tests_require``.
  1016. * Fixed not fetching eggs in ``install_requires`` when running tests.
  1017. * Allow ``ez_setup.use_setuptools()`` to upgrade existing setuptools
  1018. installations when called from a standalone ``setup.py``.
  1019. * Added a warning if a namespace package is declared, but its parent package
  1020. is not also declared as a namespace.
  1021. * Support Subversion 1.5
  1022. * Removed use of deprecated ``md5`` module if ``hashlib`` is available
  1023. * Fixed ``bdist_wininst upload`` trying to upload the ``.exe`` twice
  1024. * Fixed ``bdist_egg`` putting a ``native_libs.txt`` in the source package's
  1025. ``.egg-info``, when it should only be in the built egg's ``EGG-INFO``.
  1026. * Ensure that _full_name is set on all shared libs before extensions are
  1027. checked for shared lib usage. (Fixes a bug in the experimental shared
  1028. library build support.)
  1029. * Fix to allow unpacked eggs containing native libraries to fail more
  1030. gracefully under Google App Engine (with an ``ImportError`` loading the
  1031. C-based module, instead of getting a ``NameError``).
  1032. -----
  1033. 0.6c7
  1034. -----
  1035. * Fixed ``distutils.filelist.findall()`` crashing on broken symlinks, and
  1036. ``egg_info`` command failing on new, uncommitted SVN directories.
  1037. * Fix import problems with nested namespace packages installed via
  1038. ``--root`` or ``--single-version-externally-managed``, due to the
  1039. parent package not having the child package as an attribute.
  1040. -----
  1041. 0.6c6
  1042. -----
  1043. * Added ``--egg-path`` option to ``develop`` command, allowing you to force
  1044. ``.egg-link`` files to use relative paths (allowing them to be shared across
  1045. platforms on a networked drive).
  1046. * Fix not building binary RPMs correctly.
  1047. * Fix "eggsecutables" (such as setuptools' own egg) only being runnable with
  1048. bash-compatible shells.
  1049. * Fix ``#!`` parsing problems in Windows ``.exe`` script wrappers, when there
  1050. was whitespace inside a quoted argument or at the end of the ``#!`` line
  1051. (a regression introduced in 0.6c4).
  1052. * Fix ``test`` command possibly failing if an older version of the project
  1053. being tested was installed on ``sys.path`` ahead of the test source
  1054. directory.
  1055. * Fix ``find_packages()`` treating ``ez_setup`` and directories with ``.`` in
  1056. their names as packages.
  1057. -----
  1058. 0.6c5
  1059. -----
  1060. * Fix uploaded ``bdist_rpm`` packages being described as ``bdist_egg``
  1061. packages under Python versions less than 2.5.
  1062. * Fix uploaded ``bdist_wininst`` packages being described as suitable for
  1063. "any" version by Python 2.5, even if a ``--target-version`` was specified.
  1064. -----
  1065. 0.6c4
  1066. -----
  1067. * Overhauled Windows script wrapping to support ``bdist_wininst`` better.
  1068. Scripts installed with ``bdist_wininst`` will always use ``#!python.exe`` or
  1069. ``#!pythonw.exe`` as the executable name (even when built on non-Windows
  1070. platforms!), and the wrappers will look for the executable in the script's
  1071. parent directory (which should find the right version of Python).
  1072. * Fix ``upload`` command not uploading files built by ``bdist_rpm`` or
  1073. ``bdist_wininst`` under Python 2.3 and 2.4.
  1074. * Add support for "eggsecutable" headers: a ``#!/bin/sh`` script that is
  1075. prepended to an ``.egg`` file to allow it to be run as a script on Unix-ish
  1076. platforms. (This is mainly so that setuptools itself can have a single-file
  1077. installer on Unix, without doing multiple downloads, dealing with firewalls,
  1078. etc.)
  1079. * Fix problem with empty revision numbers in Subversion 1.4 ``entries`` files
  1080. * Use cross-platform relative paths in ``easy-install.pth`` when doing
  1081. ``develop`` and the source directory is a subdirectory of the installation
  1082. target directory.
  1083. * Fix a problem installing eggs with a system packaging tool if the project
  1084. contained an implicit namespace package; for example if the ``setup()``
  1085. listed a namespace package ``foo.bar`` without explicitly listing ``foo``
  1086. as a namespace package.
  1087. -----
  1088. 0.6c3
  1089. -----
  1090. * Fixed breakages caused by Subversion 1.4's new "working copy" format
  1091. -----
  1092. 0.6c2
  1093. -----
  1094. * The ``ez_setup`` module displays the conflicting version of setuptools (and
  1095. its installation location) when a script requests a version that's not
  1096. available.
  1097. * Running ``setup.py develop`` on a setuptools-using project will now install
  1098. setuptools if needed, instead of only downloading the egg.
  1099. -----
  1100. 0.6c1
  1101. -----
  1102. * Fixed ``AttributeError`` when trying to download a ``setup_requires``
  1103. dependency when a distribution lacks a ``dependency_links`` setting.
  1104. * Made ``zip-safe`` and ``not-zip-safe`` flag files contain a single byte, so
  1105. as to play better with packaging tools that complain about zero-length
  1106. files.
  1107. * Made ``setup.py develop`` respect the ``--no-deps`` option, which it
  1108. previously was ignoring.
  1109. * Support ``extra_path`` option to ``setup()`` when ``install`` is run in
  1110. backward-compatibility mode.
  1111. * Source distributions now always include a ``setup.cfg`` file that explicitly
  1112. sets ``egg_info`` options such that they produce an identical version number
  1113. to the source distribution's version number. (Previously, the default
  1114. version number could be different due to the use of ``--tag-date``, or if
  1115. the version was overridden on the command line that built the source
  1116. distribution.)
  1117. -----
  1118. 0.6b4
  1119. -----
  1120. * Fix ``register`` not obeying name/version set by ``egg_info`` command, if
  1121. ``egg_info`` wasn't explicitly run first on the same command line.
  1122. * Added ``--no-date`` and ``--no-svn-revision`` options to ``egg_info``
  1123. command, to allow suppressing tags configured in ``setup.cfg``.
  1124. * Fixed redundant warnings about missing ``README`` file(s); it should now
  1125. appear only if you are actually a source distribution.
  1126. -----
  1127. 0.6b3
  1128. -----
  1129. * Fix ``bdist_egg`` not including files in subdirectories of ``.egg-info``.
  1130. * Allow ``.py`` files found by the ``include_package_data`` option to be
  1131. automatically included. Remove duplicate data file matches if both
  1132. ``include_package_data`` and ``package_data`` are used to refer to the same
  1133. files.
  1134. -----
  1135. 0.6b1
  1136. -----
  1137. * Strip ``module`` from the end of compiled extension modules when computing
  1138. the name of a ``.py`` loader/wrapper. (Python's import machinery ignores
  1139. this suffix when searching for an extension module.)
  1140. ------
  1141. 0.6a11
  1142. ------
  1143. * Added ``test_loader`` keyword to support custom test loaders
  1144. * Added ``setuptools.file_finders`` entry point group to allow implementing
  1145. revision control plugins.
  1146. * Added ``--identity`` option to ``upload`` command.
  1147. * Added ``dependency_links`` to allow specifying URLs for ``--find-links``.
  1148. * Enhanced test loader to scan packages as well as modules, and call
  1149. ``additional_tests()`` if present to get non-unittest tests.
  1150. * Support namespace packages in conjunction with system packagers, by omitting
  1151. the installation of any ``__init__.py`` files for namespace packages, and
  1152. adding a special ``.pth`` file to create a working package in
  1153. ``sys.modules``.
  1154. * Made ``--single-version-externally-managed`` automatic when ``--root`` is
  1155. used, so that most system packagers won't require special support for
  1156. setuptools.
  1157. * Fixed ``setup_requires``, ``tests_require``, etc. not using ``setup.cfg`` or
  1158. other configuration files for their option defaults when installing, and
  1159. also made the install use ``--multi-version`` mode so that the project
  1160. directory doesn't need to support .pth files.
  1161. * ``MANIFEST.in`` is now forcibly closed when any errors occur while reading
  1162. it. Previously, the file could be left open and the actual error would be
  1163. masked by problems trying to remove the open file on Windows systems.
  1164. ------
  1165. 0.6a10
  1166. ------
  1167. * Fixed the ``develop`` command ignoring ``--find-links``.
  1168. -----
  1169. 0.6a9
  1170. -----
  1171. * The ``sdist`` command no longer uses the traditional ``MANIFEST`` file to
  1172. create source distributions. ``MANIFEST.in`` is still read and processed,
  1173. as are the standard defaults and pruning. But the manifest is built inside
  1174. the project's ``.egg-info`` directory as ``SOURCES.txt``, and it is rebuilt
  1175. every time the ``egg_info`` command is run.
  1176. * Added the ``include_package_data`` keyword to ``setup()``, allowing you to
  1177. automatically include any package data listed in revision control or
  1178. ``MANIFEST.in``
  1179. * Added the ``exclude_package_data`` keyword to ``setup()``, allowing you to
  1180. trim back files included via the ``package_data`` and
  1181. ``include_package_data`` options.
  1182. * Fixed ``--tag-svn-revision`` not working when run from a source
  1183. distribution.
  1184. * Added warning for namespace packages with missing ``declare_namespace()``
  1185. * Added ``tests_require`` keyword to ``setup()``, so that e.g. packages
  1186. requiring ``nose`` to run unit tests can make this dependency optional
  1187. unless the ``test`` command is run.
  1188. * Made all commands that use ``easy_install`` respect its configuration
  1189. options, as this was causing some problems with ``setup.py install``.
  1190. * Added an ``unpack_directory()`` driver to ``setuptools.archive_util``, so
  1191. that you can process a directory tree through a processing filter as if it
  1192. were a zipfile or tarfile.
  1193. * Added an internal ``install_egg_info`` command to use as part of old-style
  1194. ``install`` operations, that installs an ``.egg-info`` directory with the
  1195. package.
  1196. * Added a ``--single-version-externally-managed`` option to the ``install``
  1197. command so that you can more easily wrap a "flat" egg in a system package.
  1198. * Enhanced ``bdist_rpm`` so that it installs single-version eggs that
  1199. don't rely on a ``.pth`` file. The ``--no-egg`` option has been removed,
  1200. since all RPMs are now built in a more backwards-compatible format.
  1201. * Support full roundtrip translation of eggs to and from ``bdist_wininst``
  1202. format. Running ``bdist_wininst`` on a setuptools-based package wraps the
  1203. egg in an .exe that will safely install it as an egg (i.e., with metadata
  1204. and entry-point wrapper scripts), and ``easy_install`` can turn the .exe
  1205. back into an ``.egg`` file or directory and install it as such.
  1206. -----
  1207. 0.6a8
  1208. -----
  1209. * Fixed some problems building extensions when Pyrex was installed, especially
  1210. with Python 2.4 and/or packages using SWIG.
  1211. * Made ``develop`` command accept all the same options as ``easy_install``,
  1212. and use the ``easy_install`` command's configuration settings as defaults.
  1213. * Made ``egg_info --tag-svn-revision`` fall back to extracting the revision
  1214. number from ``PKG-INFO`` in case it is being run on a source distribution of
  1215. a snapshot taken from a Subversion-based project.
  1216. * Automatically detect ``.dll``, ``.so`` and ``.dylib`` files that are being
  1217. installed as data, adding them to ``native_libs.txt`` automatically.
  1218. * Fixed some problems with fresh checkouts of projects that don't include
  1219. ``.egg-info/PKG-INFO`` under revision control and put the project's source
  1220. code directly in the project directory. If such a package had any
  1221. requirements that get processed before the ``egg_info`` command can be run,
  1222. the setup scripts would fail with a "Missing 'Version:' header and/or
  1223. PKG-INFO file" error, because the egg runtime interpreted the unbuilt
  1224. metadata in a directory on ``sys.path`` (i.e. the current directory) as
  1225. being a corrupted egg. Setuptools now monkeypatches the distribution
  1226. metadata cache to pretend that the egg has valid version information, until
  1227. it has a chance to make it actually be so (via the ``egg_info`` command).
  1228. -----
  1229. 0.6a5
  1230. -----
  1231. * Fixed missing gui/cli .exe files in distribution. Fixed bugs in tests.
  1232. -----
  1233. 0.6a3
  1234. -----
  1235. * Added ``gui_scripts`` entry point group to allow installing GUI scripts
  1236. on Windows and other platforms. (The special handling is only for Windows;
  1237. other platforms are treated the same as for ``console_scripts``.)
  1238. -----
  1239. 0.6a2
  1240. -----
  1241. * Added ``console_scripts`` entry point group to allow installing scripts
  1242. without the need to create separate script files. On Windows, console
  1243. scripts get an ``.exe`` wrapper so you can just type their name. On other
  1244. platforms, the scripts are written without a file extension.
  1245. -----
  1246. 0.6a1
  1247. -----
  1248. * Added support for building "old-style" RPMs that don't install an egg for
  1249. the target package, using a ``--no-egg`` option.
  1250. * The ``build_ext`` command now works better when using the ``--inplace``
  1251. option and multiple Python versions. It now makes sure that all extensions
  1252. match the current Python version, even if newer copies were built for a
  1253. different Python version.
  1254. * The ``upload`` command no longer attaches an extra ``.zip`` when uploading
  1255. eggs, as PyPI now supports egg uploads without trickery.
  1256. * The ``ez_setup`` script/module now displays a warning before downloading
  1257. the setuptools egg, and attempts to check the downloaded egg against an
  1258. internal MD5 checksum table.
  1259. * Fixed the ``--tag-svn-revision`` option of ``egg_info`` not finding the
  1260. latest revision number; it was using the revision number of the directory
  1261. containing ``setup.py``, not the highest revision number in the project.
  1262. * Added ``eager_resources`` setup argument
  1263. * The ``sdist`` command now recognizes Subversion "deleted file" entries and
  1264. does not include them in source distributions.
  1265. * ``setuptools`` now embeds itself more thoroughly into the distutils, so that
  1266. other distutils extensions (e.g. py2exe, py2app) will subclass setuptools'
  1267. versions of things, rather than the native distutils ones.
  1268. * Added ``entry_points`` and ``setup_requires`` arguments to ``setup()``;
  1269. ``setup_requires`` allows you to automatically find and download packages
  1270. that are needed in order to *build* your project (as opposed to running it).
  1271. * ``setuptools`` now finds its commands, ``setup()`` argument validators, and
  1272. metadata writers using entry points, so that they can be extended by
  1273. third-party packages. See `Creating distutils Extensions
  1274. <http://pythonhosted.org/setuptools/setuptools.html#creating-distutils-extensions>`_
  1275. for more details.
  1276. * The vestigial ``depends`` command has been removed. It was never finished
  1277. or documented, and never would have worked without EasyInstall - which it
  1278. pre-dated and was never compatible with.
  1279. ------
  1280. 0.5a12
  1281. ------
  1282. * The zip-safety scanner now checks for modules that might be used with
  1283. ``python -m``, and marks them as unsafe for zipping, since Python 2.4 can't
  1284. handle ``-m`` on zipped modules.
  1285. ------
  1286. 0.5a11
  1287. ------
  1288. * Fix breakage of the "develop" command that was caused by the addition of
  1289. ``--always-unzip`` to the ``easy_install`` command.
  1290. -----
  1291. 0.5a9
  1292. -----
  1293. * Include ``svn:externals`` directories in source distributions as well as
  1294. normal subversion-controlled files and directories.
  1295. * Added ``exclude=patternlist`` option to ``setuptools.find_packages()``
  1296. * Changed --tag-svn-revision to include an "r" in front of the revision number
  1297. for better readability.
  1298. * Added ability to build eggs without including source files (except for any
  1299. scripts, of course), using the ``--exclude-source-files`` option to
  1300. ``bdist_egg``.
  1301. * ``setup.py install`` now automatically detects when an "unmanaged" package
  1302. or module is going to be on ``sys.path`` ahead of a package being installed,
  1303. thereby preventing the newer version from being imported. If this occurs,
  1304. a warning message is output to ``sys.stderr``, but installation proceeds
  1305. anyway. The warning message informs the user what files or directories
  1306. need deleting, and advises them they can also use EasyInstall (with the
  1307. ``--delete-conflicting`` option) to do it automatically.
  1308. * The ``egg_info`` command now adds a ``top_level.txt`` file to the metadata
  1309. directory that lists all top-level modules and packages in the distribution.
  1310. This is used by the ``easy_install`` command to find possibly-conflicting
  1311. "unmanaged" packages when installing the distribution.
  1312. * Added ``zip_safe`` and ``namespace_packages`` arguments to ``setup()``.
  1313. Added package analysis to determine zip-safety if the ``zip_safe`` flag
  1314. is not given, and advise the author regarding what code might need changing.
  1315. * Fixed the swapped ``-d`` and ``-b`` options of ``bdist_egg``.
  1316. -----
  1317. 0.5a8
  1318. -----
  1319. * The "egg_info" command now always sets the distribution metadata to "safe"
  1320. forms of the distribution name and version, so that distribution files will
  1321. be generated with parseable names (i.e., ones that don't include '-' in the
  1322. name or version). Also, this means that if you use the various ``--tag``
  1323. options of "egg_info", any distributions generated will use the tags in the
  1324. version, not just egg distributions.
  1325. * Added support for defining command aliases in distutils configuration files,
  1326. under the "[aliases]" section. To prevent recursion and to allow aliases to
  1327. call the command of the same name, a given alias can be expanded only once
  1328. per command-line invocation. You can define new aliases with the "alias"
  1329. command, either for the local, global, or per-user configuration.
  1330. * Added "rotate" command to delete old distribution files, given a set of
  1331. patterns to match and the number of files to keep. (Keeps the most
  1332. recently-modified distribution files matching each pattern.)
  1333. * Added "saveopts" command that saves all command-line options for the current
  1334. invocation to the local, global, or per-user configuration file. Useful for
  1335. setting defaults without having to hand-edit a configuration file.
  1336. * Added a "setopt" command that sets a single option in a specified distutils
  1337. configuration file.
  1338. -----
  1339. 0.5a7
  1340. -----
  1341. * Added "upload" support for egg and source distributions, including a bug
  1342. fix for "upload" and a temporary workaround for lack of .egg support in
  1343. PyPI.
  1344. -----
  1345. 0.5a6
  1346. -----
  1347. * Beefed up the "sdist" command so that if you don't have a MANIFEST.in, it
  1348. will include all files under revision control (CVS or Subversion) in the
  1349. current directory, and it will regenerate the list every time you create a
  1350. source distribution, not just when you tell it to. This should make the
  1351. default "do what you mean" more often than the distutils' default behavior
  1352. did, while still retaining the old behavior in the presence of MANIFEST.in.
  1353. * Fixed the "develop" command always updating .pth files, even if you
  1354. specified ``-n`` or ``--dry-run``.
  1355. * Slightly changed the format of the generated version when you use
  1356. ``--tag-build`` on the "egg_info" command, so that you can make tagged
  1357. revisions compare *lower* than the version specified in setup.py (e.g. by
  1358. using ``--tag-build=dev``).
  1359. -----
  1360. 0.5a5
  1361. -----
  1362. * Added ``develop`` command to ``setuptools``-based packages. This command
  1363. installs an ``.egg-link`` pointing to the package's source directory, and
  1364. script wrappers that ``execfile()`` the source versions of the package's
  1365. scripts. This lets you put your development checkout(s) on sys.path without
  1366. having to actually install them. (To uninstall the link, use
  1367. use ``setup.py develop --uninstall``.)
  1368. * Added ``egg_info`` command to ``setuptools``-based packages. This command
  1369. just creates or updates the "projectname.egg-info" directory, without
  1370. building an egg. (It's used by the ``bdist_egg``, ``test``, and ``develop``
  1371. commands.)
  1372. * Enhanced the ``test`` command so that it doesn't install the package, but
  1373. instead builds any C extensions in-place, updates the ``.egg-info``
  1374. metadata, adds the source directory to ``sys.path``, and runs the tests
  1375. directly on the source. This avoids an "unmanaged" installation of the
  1376. package to ``site-packages`` or elsewhere.
  1377. * Made ``easy_install`` a standard ``setuptools`` command, moving it from
  1378. the ``easy_install`` module to ``setuptools.command.easy_install``. Note
  1379. that if you were importing or extending it, you must now change your imports
  1380. accordingly. ``easy_install.py`` is still installed as a script, but not as
  1381. a module.
  1382. -----
  1383. 0.5a4
  1384. -----
  1385. * Setup scripts using setuptools can now list their dependencies directly in
  1386. the setup.py file, without having to manually create a ``depends.txt`` file.
  1387. The ``install_requires`` and ``extras_require`` arguments to ``setup()``
  1388. are used to create a dependencies file automatically. If you are manually
  1389. creating ``depends.txt`` right now, please switch to using these setup
  1390. arguments as soon as practical, because ``depends.txt`` support will be
  1391. removed in the 0.6 release cycle. For documentation on the new arguments,
  1392. see the ``setuptools.dist.Distribution`` class.
  1393. * Setup scripts using setuptools now always install using ``easy_install``
  1394. internally, for ease of uninstallation and upgrading.
  1395. -----
  1396. 0.5a1
  1397. -----
  1398. * Added support for "self-installation" bootstrapping. Packages can now
  1399. include ``ez_setup.py`` in their source distribution, and add the following
  1400. to their ``setup.py``, in order to automatically bootstrap installation of
  1401. setuptools as part of their setup process::
  1402. from ez_setup import use_setuptools
  1403. use_setuptools()
  1404. from setuptools import setup
  1405. # etc...
  1406. -----
  1407. 0.4a2
  1408. -----
  1409. * Added ``ez_setup.py`` installer/bootstrap script to make initial setuptools
  1410. installation easier, and to allow distributions using setuptools to avoid
  1411. having to include setuptools in their source distribution.
  1412. * All downloads are now managed by the ``PackageIndex`` class (which is now
  1413. subclassable and replaceable), so that embedders can more easily override
  1414. download logic, give download progress reports, etc. The class has also
  1415. been moved to the new ``setuptools.package_index`` module.
  1416. * The ``Installer`` class no longer handles downloading, manages a temporary
  1417. directory, or tracks the ``zip_ok`` option. Downloading is now handled
  1418. by ``PackageIndex``, and ``Installer`` has become an ``easy_install``
  1419. command class based on ``setuptools.Command``.
  1420. * There is a new ``setuptools.sandbox.run_setup()`` API to invoke a setup
  1421. script in a directory sandbox, and a new ``setuptools.archive_util`` module
  1422. with an ``unpack_archive()`` API. These were split out of EasyInstall to
  1423. allow reuse by other tools and applications.
  1424. * ``setuptools.Command`` now supports reinitializing commands using keyword
  1425. arguments to set/reset options. Also, ``Command`` subclasses can now set
  1426. their ``command_consumes_arguments`` attribute to ``True`` in order to
  1427. receive an ``args`` option containing the rest of the command line.
  1428. -----
  1429. 0.3a2
  1430. -----
  1431. * Added new options to ``bdist_egg`` to allow tagging the egg's version number
  1432. with a subversion revision number, the current date, or an explicit tag
  1433. value. Run ``setup.py bdist_egg --help`` to get more information.
  1434. * Misc. bug fixes
  1435. -----
  1436. 0.3a1
  1437. -----
  1438. * Initial release.