CHANGES.rst 84.8 KB
Newer Older
1 2 3 4
=======
CHANGES
=======

Jason R. Coombs's avatar
Jason R. Coombs committed
5 6 7 8 9
v24.2.0
-------

* #631: Add support for ``python_requires`` keyword.

Jason R. Coombs's avatar
Jason R. Coombs committed
10 11 12 13 14
v24.1.1
-------

* More style updates. See #660, #661, #641.

15 16 17 18 19
v24.1.0
-------

* #659: ``setup.py`` now will fail fast and with a helpful
  error message when the necessary metadata is missing.
Jason R. Coombs's avatar
Jason R. Coombs committed
20 21
* More style updates. See #656, #635, #640,
  #644, #650, #652, and #655.
22

Jason R. Coombs's avatar
Jason R. Coombs committed
23 24 25 26 27 28 29
v24.0.3
-------

* Updated style in much of the codebase to match
  community expectations. See #632, #633, #634,
  #637, #639, #638, #642, #648.

J. Goutin's avatar
J. Goutin committed
30 31 32
v24.0.2
-------

J. Goutin's avatar
J. Goutin committed
33
* If MSVC++14 is needed ``setuptools.msvc`` now redirect
J. Goutin's avatar
J. Goutin committed
34 35
  user to Visual C++ Build Tools web page.

J. Goutin's avatar
J. Goutin committed
36 37 38
v24.0.1
-------

39 40
* #625 and #626: Fixes on ``setuptools.msvc`` mainly
  for Python 2 and Linux.
J. Goutin's avatar
J. Goutin committed
41

Jason R. Coombs's avatar
Jason R. Coombs committed
42 43
v24.0.0
-------
Jason R. Coombs's avatar
Jason R. Coombs committed
44 45

* Pull Request #174: Add more aggressive support for
J. Goutin's avatar
J. Goutin committed
46 47
  standalone Microsoft Visual C++ compilers in
  msvc9compiler patch.
J. Goutin's avatar
J. Goutin committed
48 49
  Particularly : Windows SDK 6.1 and 7.0
  (MSVC++ 9.0), Windows SDK 7.1 (MSVC++ 10.0),
J. Goutin's avatar
J. Goutin committed
50
  Visual C++ Build Tools 2015 (MSVC++14)
51 52
* Renamed ``setuptools.msvc9_support`` to
  ``setuptools.msvc``.
Jason R. Coombs's avatar
Jason R. Coombs committed
53

Jason R. Coombs's avatar
Jason R. Coombs committed
54
v23.2.1
Jason R. Coombs's avatar
Jason R. Coombs committed
55 56
-------

Jason R. Coombs's avatar
Jason R. Coombs committed
57 58 59
Re-release of v23.2.0, which was missing the intended
commits.

Jason R. Coombs's avatar
Jason R. Coombs committed
60 61 62
* #623: Remove used of deprecated 'U' flag when reading
  manifests.

63 64 65 66 67 68
v23.1.0
-------

* #619: Deprecated ``tag_svn_revision`` distribution
  option.

69 70 71 72 73 74
v23.0.0
-------

* #611: Removed ARM executables for CLI and GUI script
  launchers on Windows. If this was a feature you cared
  about, please comment in the ticket.
Jason R. Coombs's avatar
Jason R. Coombs committed
75 76 77
* #604: Removed docs building support. The project
  now relies on documentation hosted at
  https://setuptools.readthedocs.io/.
78

79 80 81 82 83 84
v22.0.5
-------

* #604: Restore repository for upload_docs command
  to restore publishing of docs during release.

85 86 87 88 89 90
v22.0.4
-------

* #589: Upload releases to pypi.io using the upload
  hostname and legacy path.

91 92 93 94 95 96
v22.0.3
-------

* #589: Releases are now uploaded to pypi.io (Warehouse)
  even when releases are made on Twine via Travis.

97 98 99 100 101
v22.0.2
-------

* #589: Releases are now uploaded to pypi.io (Warehouse).

Jason R. Coombs's avatar
Jason R. Coombs committed
102 103 104 105 106 107 108
v22.0.1
-------

* #190: On Python 2, if unicode is passed for packages to
  ``build_py`` command, it will be handled just as with
  text on Python 3.

109
v22.0.0
110 111
-------

112 113 114
Intended to be v21.3.0, but jaraco accidentally released as
a major bump.

115 116 117 118 119
* #598: Setuptools now lists itself first in the User-Agent
  for web requests, better following the guidelines in
  `RFC 7231
  <https://tools.ietf.org/html/rfc7231#section-5.5.3>`_.

Jason R. Coombs's avatar
Jason R. Coombs committed
120 121 122 123 124
v21.2.2
-------

* Minor fixes to changelog and docs.

125 126 127 128 129 130
v21.2.1
-------

* #261: Exclude directories when resolving globs in
  package_data.

Jason R. Coombs's avatar
Jason R. Coombs committed
131 132 133 134 135 136
v21.2.0
-------

* #539: In the easy_install get_site_dirs, honor all
  paths found in ``site.getsitepackages``.

137 138 139 140 141 142 143 144
v21.1.0
-------

* #572: In build_ext, now always import ``_CONFIG_VARS``
  from ``distutils`` rather than from ``sysconfig``
  to allow ``distutils.sysconfig.customize_compiler``
  configure the OS X compiler for ``-dynamiclib``.

145 146 147 148 149 150 151 152 153
v21.0.0
-------

* Removed ez_setup.py from Setuptools sdist. The
  bootstrap script will be maintained in its own
  branch and should be generally be retrieved from
  its canonical location at
  https://bootstrap.pypa.io/ez_setup.py.

154 155 156 157 158 159 160
v20.10.0
--------

* #553: egg_info section is now generated in a
  deterministic order, matching the order generated
  by earlier versions of Python. Except on Python 2.6,
  order is preserved when existing settings are present.
Jason R. Coombs's avatar
Jason R. Coombs committed
161 162
* #556: Update to Packaging 16.7, restoring support
  for deprecated ``python_implmentation`` marker.
Jason R. Coombs's avatar
Jason R. Coombs committed
163 164 165
* #555: Upload command now prompts for a password
  when uploading to PyPI (or other repository) if no
  password is present in .pypirc or in the keyring.
166

Jason R. Coombs's avatar
Jason R. Coombs committed
167 168 169 170 171 172 173
v20.9.0
-------

* #548: Update certify version to 2016.2.28
* #545: Safely handle deletion of non-zip eggs in rotate
  command.

174 175 176 177 178 179
v20.8.1
-------

* Issue #544: Fix issue with extra environment marker
  processing in WorkingSet due to refactor in v20.7.0.

180 181 182 183 184 185 186
v20.8.0
-------

* Issue #543: Re-release so that latest release doesn't
  cause déjà vu with distribute and setuptools 0.7 in
  older environments.

Jason R. Coombs's avatar
Jason R. Coombs committed
187 188
v20.7.0
-------
189

stepshal's avatar
stepshal committed
190
* Refactored extra environment marker processing
Jason R. Coombs's avatar
Jason R. Coombs committed
191 192
  in WorkingSet.
* Issue #533: Fixed intermittent test failures.
193 194 195
* Issue #536: In msvc9_support, trap additional exceptions
  that might occur when importing
  ``distutils.msvc9compiler`` in mingw environments.
Jason R. Coombs's avatar
Jason R. Coombs committed
196 197
* Issue #537: Provide better context when package
  metadata fails to decode in UTF-8.
198

Jason R. Coombs's avatar
Jason R. Coombs committed
199 200 201 202 203 204
v20.6.8
-------

* Issue #523: Restored support for environment markers,
  now honoring 'extra' environment markers.

205 206 207 208 209 210
v20.6.7
-------

* Issue #523: Disabled support for environment markers
  introduced in v20.5.

Jason R. Coombs's avatar
Jason R. Coombs committed
211 212 213 214 215 216
v20.6.6
-------

* Issue #503: Restore support for PEP 345 environment
  markers by updating to Packaging 16.6.

217 218
v20.6.0
-------
219 220 221 222

* New release process that relies on
  `bumpversion <https://github.com/peritus/bumpversion>`_
  and Travis CI for continuous deployment.
223 224
* Project versioning semantics now follow
  `semver <https://semver.org>`_ precisely.
Jason R. Coombs's avatar
Jason R. Coombs committed
225 226 227
  The 'v' prefix on version numbers now also allows
  version numbers to be referenced in the changelog,
  e.g. https://pythonhosted.org/setuptools/history.html#v20-6-0.
228

229 230 231
20.5
----

232
* BB Pull Request #185, #470: Add support for environment markers
233 234 235 236
  in requirements in install_requires, setup_requires,
  tests_require as well as adding a test for the existing
  extra_requires machinery.

237 238 239
20.4
----

240 241
* Issue #422: Moved hosting to
  `Github <https://github.com/pypa/setuptools>`_
242 243 244 245 246 247 248 249
  from `Bitbucket <https://bitbucket.org/pypa/setuptools>`_.
  Issues have been migrated, though all issues and comments
  are attributed to bb-migration. So if you have a particular
  issue or issues to which you've been subscribed, you will
  want to "watch" the equivalent issue in Github.
  The Bitbucket project will be retained for the indefinite
  future, but Github now hosts the canonical project repository.

Jason R. Coombs's avatar
Jason R. Coombs committed
250 251 252 253 254
20.3.1
------

* Issue #519: Remove import hook when reloading the
  ``pkg_resources`` module.
255
* BB Pull Request #184: Update documentation in ``pkg_resources``
Jason R. Coombs's avatar
Jason R. Coombs committed
256
  around new ``Requirement`` implementation.
Jason R. Coombs's avatar
Jason R. Coombs committed
257

Jason R. Coombs's avatar
Jason R. Coombs committed
258 259 260
20.3
----

261
* BB Pull Request #179: ``pkg_resources.Requirement`` objects are
Jason R. Coombs's avatar
Jason R. Coombs committed
262 263 264
  now a subclass of ``packaging.requirements.Requirement``,
  allowing any environment markers and url (if any) to be
  affiliated with the requirement
265
* BB Pull Request #179: Restore use of RequirementParseError
Jason R. Coombs's avatar
Jason R. Coombs committed
266 267
  exception unintentionally dropped in 20.2.

Jason R. Coombs's avatar
Jason R. Coombs committed
268 269 270 271 272 273
20.2.2
------

* Issue #502: Correct regression in parsing of multiple
  version specifiers separated by commas and spaces.

Jason R. Coombs's avatar
Jason R. Coombs committed
274 275 276
20.2.1
------

stepshal's avatar
stepshal committed
277
* Issue #499: Restore compatibility for legacy versions
Jason R. Coombs's avatar
Jason R. Coombs committed
278 279
  by bumping to packaging 16.4.

Jason R. Coombs's avatar
Jason R. Coombs committed
280 281 282 283
20.2
----

* Changelog now includes release dates and links to PEPs.
284
* BB Pull Request #173: Replace dual PEP 345 _markerlib implementation
285 286
  and PEP 426 implementation of environment marker support from
  packaging 16.1 and PEP 508. Fixes Issue #122.
287 288
  See also BB Pull Request #175, BB Pull Request #168, and
  BB Pull Request #164. Additionally:
Jason R. Coombs's avatar
Jason R. Coombs committed
289

290 291 292 293 294
   - ``Requirement.parse`` no longer retains the order of extras.
   - ``parse_requirements`` now requires that all versions be
     PEP-440 compliant, as revealed in #499. Packages released
     with invalid local versions should be re-released using
     the proper local version syntax, e.g. ``mypkg-1.0+myorg.1``.
Jason R. Coombs's avatar
Jason R. Coombs committed
295

296 297 298 299 300 301
20.1.1
------

* Update ``upload_docs`` command to also honor keyring
  for password resolution.

302 303 304
20.1
----

305
* Added support for using passwords from keyring in the upload
306 307 308
  command. See `the upload docs
  <http://pythonhosted.org/setuptools/setuptools.html#upload-upload-source-and-or-egg-distributions-to-pypi>`_
  for details.
309

310 311 312 313 314 315 316
20.0
----

* Issue #118: Once again omit the package metadata (egg-info)
  from the list of outputs in ``--record``. This version of setuptools
  can no longer be used to upgrade pip earlier than 6.0.

Jason R. Coombs's avatar
Jason R. Coombs committed
317 318 319 320 321 322
19.7
----

* `Off-project PR <https://github.com/jaraco/setuptools/pull/32>`_:
  For FreeBSD, also honor root certificates from ca_root_nss.

Jason R. Coombs's avatar
Jason R. Coombs committed
323 324 325 326 327 328 329
19.6.2
------

* Issue #491: Correct regression incurred in 19.4 where
  a double-namespace package installed using pip would
  cause a TypeError.

Jason R. Coombs's avatar
Jason R. Coombs committed
330 331 332 333 334 335 336 337 338
19.6.1
------

* Restore compatibility for PyPy 3 compatibility lost in
  19.4.1 addressing Issue #487.
* ``setuptools.launch`` shim now loads scripts in a new
  namespace, avoiding getting relative imports from
  the setuptools package on Python 2.

339 340 341 342 343 344 345 346 347 348 349 350 351 352
19.6
----

* Added a new entry script ``setuptools.launch``,
  implementing the shim found in
  ``pip.util.setuptools_build``. Use this command to launch
  distutils-only packages under setuptools in the same way that
  pip does, causing the setuptools monkeypatching of distutils
  to be invoked prior to invoking a script. Useful for debugging
  or otherwise installing a distutils-only package under
  setuptools when pip isn't available or otherwise does not
  expose the desired functionality. For example::

    $ python -m setuptools.launch setup.py develop
Jason R. Coombs's avatar
Jason R. Coombs committed
353

354 355 356
* Issue #488: Fix dual manifestation of Extension class in
  extension packages installed as dependencies when Cython
  is present.
357

Jason R. Coombs's avatar
Jason R. Coombs committed
358 359
19.5
----
360 361 362

* Issue #486: Correct TypeError when getfilesystemencoding
  returns None.
Jason R. Coombs's avatar
Jason R. Coombs committed
363
* Issue #139: Clarified the license as MIT.
364
* BB Pull Request #169: Removed special handling of command
Jason R. Coombs's avatar
Jason R. Coombs committed
365
  spec in scripts for Jython.
366

367 368 369 370 371 372 373
19.4.1
------

* Issue #487: Use direct invocation of ``importlib.machinery``
  in ``pkg_resources`` to avoid missing detection on relevant
  platforms.

Jason R. Coombs's avatar
Jason R. Coombs committed
374 375
19.4
----
376 377 378

* Issue #341: Correct error in path handling of package data
  files in ``build_py`` command when package is empty.
Jason R. Coombs's avatar
Jason R. Coombs committed
379
* Distribute #323, Issue #141, Issue #207, and
380
  BB Pull Request #167: Another implementation of
Jason R. Coombs's avatar
Jason R. Coombs committed
381 382 383 384
  ``pkg_resources.WorkingSet`` and ``pkg_resources.Distribution``
  that supports replacing an extant package with a new one,
  allowing for setup_requires dependencies to supersede installed
  packages for the session.
385

Jason R. Coombs's avatar
Jason R. Coombs committed
386 387 388 389 390 391
19.3
----

* Issue #229: Implement new technique for readily incorporating
  dependencies conditionally from vendored copies or primary
  locations. Adds a new dependency on six.
Jason R. Coombs's avatar
Jason R. Coombs committed
392

Jason R. Coombs's avatar
Jason R. Coombs committed
393 394 395
19.2
----

396 397
* BB Pull Request #163: Add get_command_list method to Distribution.
* BB Pull Request #162: Add missing whitespace to multiline string
Jason R. Coombs's avatar
Jason R. Coombs committed
398
  literals.
Jason R. Coombs's avatar
Jason R. Coombs committed
399

400 401 402 403 404
19.1.1
------

* Issue #476: Cast version to string (using default encoding)
  to avoid creating Unicode types on Python 2 clients.
405 406 407
* Issue #477: In Powershell downloader, use explicit rendering
  of strings, rather than rely on ``repr``, which can be
  incorrect (especially on Python 2).
408

Jason R. Coombs's avatar
Jason R. Coombs committed
409 410 411
19.1
----

412 413
* Issue #215: The bootstrap script ``ez_setup.py`` now
  automatically detects
Jason R. Coombs's avatar
Jason R. Coombs committed
414 415
  the latest version of setuptools (using PyPI JSON API) rather
  than hard-coding a particular value.
Jason R. Coombs's avatar
Jason R. Coombs committed
416
* Issue #475: Fix incorrect usage in _translate_metadata2.
Jason R. Coombs's avatar
Jason R. Coombs committed
417

418 419 420
19.0
----

421 422
* Issue #442: Use RawConfigParser for parsing .pypirc file.
  Interpolated values are no longer honored in .pypirc files.
423

424 425 426 427 428 429 430 431
18.8.1
------

* Issue #440: Prevent infinite recursion when a SandboxViolation
  or other UnpickleableException occurs in a sandbox context
  with setuptools hidden. Fixes regression introduced in Setuptools
  12.0.

432 433
18.8
----
Jason R. Coombs's avatar
Jason R. Coombs committed
434

435
* Deprecated ``egg_info.get_pkg_info_revision``.
Jason R. Coombs's avatar
Jason R. Coombs committed
436 437
* Issue #471: Don't rely on repr for an HTML attribute value in
  package_index.
438 439
* Issue #419: Avoid errors in FileMetadata when the metadata directory
  is broken.
440 441
* Issue #472: Remove deprecated use of 'U' in mode parameter
  when opening files.
Jason R. Coombs's avatar
Jason R. Coombs committed
442

443 444 445 446 447 448
18.7.1
------

* Issue #469: Refactored logic for Issue #419 fix to re-use metadata
  loading from Provider.

Jason R. Coombs's avatar
Jason R. Coombs committed
449 450 451 452
18.7
----

* Update dependency on certify.
453
* BB Pull Request #160: Improve detection of gui script in
Jason R. Coombs's avatar
Jason R. Coombs committed
454
  ``easy_install._adjust_header``.
455
* Made ``test.test_args`` a non-data property; alternate fix
456
  for the issue reported in BB Pull Request #155.
Jason R. Coombs's avatar
Jason R. Coombs committed
457 458
* Issue #453: In ``ez_setup`` bootstrap module, unload all
  ``pkg_resources`` modules following download.
459
* BB Pull Request #158: Honor PEP-488 when excluding
Jason R. Coombs's avatar
Jason R. Coombs committed
460
  files for namespace packages.
461
* Issue #419 and BB Pull Request #144: Add experimental support for
462 463
  reading the version info from distutils-installed metadata rather
  than using the version in the filename.
Jason R. Coombs's avatar
Jason R. Coombs committed
464

Jason R. Coombs's avatar
Jason R. Coombs committed
465 466 467 468 469 470
18.6.1
------

* Issue #464: Correct regression in invocation of superclass on old-style
  class on Python 2.

471 472 473 474 475 476 477
18.6
----

* Issue #439: When installing entry_point scripts under development,
  omit the version number of the package, allowing any version of the
  package to be used.

478 479 480 481 482 483
18.5
----

* In preparation for dropping support for Python 3.2, a warning is
  now logged when pkg_resources is imported on Python 3.2 or earlier
  Python 3 versions.
Jason R. Coombs's avatar
Jason R. Coombs committed
484 485 486 487
* `Add support for python_platform_implementation environment marker
  <https://github.com/jaraco/setuptools/pull/28>`_.
* `Fix dictionary mutation during iteration
  <https://github.com/jaraco/setuptools/pull/29>`_.
488

Jason R. Coombs's avatar
Jason R. Coombs committed
489 490 491 492 493 494
18.4
----

* Issue #446: Test command now always invokes unittest, even
  if no test suite is supplied.

Jason R. Coombs's avatar
Jason R. Coombs committed
495 496 497 498 499 500
18.3.2
------

* Correct another regression in setuptools.findall
  where the fix for Python #12885 was lost.

Jason R. Coombs's avatar
Jason R. Coombs committed
501 502 503 504 505
18.3.1
------

* Issue #425: Correct regression in setuptools.findall.

506 507 508 509 510 511 512 513 514 515 516 517 518 519
18.3
----

* Setuptools now allows disabling of the manipulation of the sys.path
  during the processing of the easy-install.pth file. To do so, set
  the environment variable ``SETUPTOOLS_SYS_PATH_TECHNIQUE`` to
  anything but "rewrite" (consider "raw"). During any install operation
  with manipulation disabled, setuptools packages will be appended to
  sys.path naturally.

  Future versions may change the default behavior to disable
  manipulation. If so, the default behavior can be retained by setting
  the variable to "rewrite".

Jason R. Coombs's avatar
Jason R. Coombs committed
520 521 522
* Issue #257: ``easy_install --version`` now shows more detail
  about the installation location and Python version.

Jason R. Coombs's avatar
Jason R. Coombs committed
523 524 525
* Refactor setuptools.findall in preparation for re-submission
  back to distutils.

526 527 528 529 530
18.2
----

* Issue #412: More efficient directory search in ``find_packages``.

Jason R. Coombs's avatar
Jason R. Coombs committed
531 532 533 534 535
18.1
----

* Upgrade to vendored packaging 15.3.

536 537 538 539 540
18.0.1
------

* Issue #401: Fix failure in test suite.

541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
18.0
----

* Dropped support for builds with Pyrex. Only Cython is supported.
* Issue #288: Detect Cython later in the build process, after
  ``setup_requires`` dependencies are resolved.
  Projects backed by Cython can now be readily built
  with a ``setup_requires`` dependency. For example::

    ext = setuptools.Extension('mylib', ['src/CythonStuff.pyx', 'src/CStuff.c'])
    setuptools.setup(
        ...
        ext_modules=[ext],
        setup_requires=['cython'],
    )

  For compatibility with older versions of setuptools, packagers should
  still include ``src/CythonMod.c`` in the source distributions or
  require that Cython be present before building source distributions.
  However, for systems with this build of setuptools, Cython will be
  downloaded on demand.
Jason R. Coombs's avatar
Jason R. Coombs committed
562
* Issue #396: Fixed test failure on OS X.
563
* BB Pull Request #136: Remove excessive quoting from shebang headers
Jason R. Coombs's avatar
Jason R. Coombs committed
564
  for Jython.
565

Jason R. Coombs's avatar
Jason R. Coombs committed
566 567 568 569 570 571 572
17.1.1
------

* Backed out unintended changes to pkg_resources, restoring removal of
  deprecated imp module (`ref
  <https://bitbucket.org/pypa/setuptools/commits/f572ec9563d647fa8d4ffc534f2af8070ea07a8b#comment-1881283>`_).

Jason R. Coombs's avatar
Jason R. Coombs committed
573 574 575 576 577 578
17.1
----

* Issue #380: Add support for range operators on environment
  marker evaluation.

Jason R. Coombs's avatar
Jason R. Coombs committed
579 580 581
17.0
----

582
* Issue #378: Do not use internal importlib._bootstrap module.
Jason R. Coombs's avatar
Jason R. Coombs committed
583 584
* Issue #390: Disallow console scripts with path separators in
  the name. Removes unintended functionality and brings behavior
Jason R. Coombs's avatar
Jason R. Coombs committed
585
  into parity with pip.
Jason R. Coombs's avatar
Jason R. Coombs committed
586

Jason R. Coombs's avatar
Jason R. Coombs committed
587
16.0
Jason R. Coombs's avatar
Jason R. Coombs committed
588 589
----

590
* BB Pull Request #130: Better error messages for errors in
Jason R. Coombs's avatar
Jason R. Coombs committed
591
  parsed requirements.
592
* BB Pull Request #133: Removed ``setuptools.tests`` from the
Jason R. Coombs's avatar
Jason R. Coombs committed
593
  installed packages.
594
* BB Pull Request #129: Address deprecation warning due to usage
Jason R. Coombs's avatar
Jason R. Coombs committed
595
  of imp module.
Jason R. Coombs's avatar
Jason R. Coombs committed
596

Jason R. Coombs's avatar
Jason R. Coombs committed
597 598 599 600 601 602 603
15.2
----

* Issue #373: Provisionally expose
  ``pkg_resources._initialize_master_working_set``, allowing for
  imperative re-initialization of the master working set.

604 605 606
15.1
----

Jason R. Coombs's avatar
Jason R. Coombs committed
607
* Updated to Packaging 15.1 to address Packaging #28.
Jason R. Coombs's avatar
Jason R. Coombs committed
608
* Fix ``setuptools.sandbox._execfile()`` with Python 3.1.
609

Jason R. Coombs's avatar
Jason R. Coombs committed
610 611 612
15.0
----

613
* BB Pull Request #126: DistributionNotFound message now lists the package or
Jason R. Coombs's avatar
Jason R. Coombs committed
614 615 616 617 618 619 620
  packages that required it. E.g.::

      pkg_resources.DistributionNotFound: The 'colorama>=0.3.1' distribution was not found and is required by smlib.log.

  Note that zc.buildout once dependended on the string rendering of this
  message to determine the package that was not found. This expectation
  has since been changed, but older versions of buildout may experience
Jason R. Coombs's avatar
Jason R. Coombs committed
621
  problems. See Buildout #242 for details.
Jason R. Coombs's avatar
Jason R. Coombs committed
622

Jason R. Coombs's avatar
Jason R. Coombs committed
623 624 625 626 627 628 629 630
14.3.1
------

* Issue #307: Removed PEP-440 warning during parsing of versions
  in ``pkg_resources.Distribution``.
* Issue #364: Replace deprecated usage with recommended usage of
  ``EntryPoint.load``.

631 632 633 634 635 636 637
14.3
----

* Issue #254: When creating temporary egg cache on Unix, use mode 755
  for creating the directory to avoid the subsequent warning if
  the directory is group writable.

Jason R. Coombs's avatar
Jason R. Coombs committed
638 639 640 641 642 643 644
14.2
----

* Issue #137: Update ``Distribution.hashcmp`` so that Distributions with
  None for pyversion or platform can be compared against Distributions
  defining those attributes.

Jason R. Coombs's avatar
Jason R. Coombs committed
645 646 647 648 649 650
14.1.1
------

* Issue #360: Removed undesirable behavior from test runs, preventing
  write tests and installation to system site packages.

Jason R. Coombs's avatar
Jason R. Coombs committed
651 652 653
14.1
----

654
* BB Pull Request #125: Add ``__ne__`` to Requirement class.
Jason R. Coombs's avatar
Jason R. Coombs committed
655 656
* Various refactoring of easy_install.

Jason R. Coombs's avatar
Jason R. Coombs committed
657
14.0
658 659
----

Jason R. Coombs's avatar
Jason R. Coombs committed
660 661
* Bootstrap script now accepts ``--to-dir`` to customize save directory or
  allow for re-use of existing repository of setuptools versions. See
662
  BB Pull Request #112 for background.
Jason R. Coombs's avatar
Jason R. Coombs committed
663 664 665 666 667 668 669 670
* Issue #285: ``easy_install`` no longer will default to installing
  packages to the "user site packages" directory if it is itself installed
  there. Instead, the user must pass ``--user`` in all cases to install
  packages to the user site packages.
  This behavior now matches that of "pip install". To configure
  an environment to always install to the user site packages, consider
  using the "install-dir" and "scripts-dir" parameters to easy_install
  through an appropriate distutils config file.
671

672 673 674 675 676 677
13.0.2
------

* Issue #359: Include pytest.ini in the sdist so invocation of py.test on the
  sdist honors the pytest configuration.

Jason R. Coombs's avatar
Jason R. Coombs committed
678 679 680 681 682 683
13.0.1
------

Re-release of 13.0. Intermittent connectivity issues caused the release
process to fail and PyPI uploads no longer accept files for 13.0.

Jason R. Coombs's avatar
Jason R. Coombs committed
684 685 686
13.0
----

687
* Issue #356: Back out BB Pull Request #119 as it requires Setuptools 10 or later
Jason R. Coombs's avatar
Jason R. Coombs committed
688
  as the source during an upgrade.
Jason R. Coombs's avatar
Jason R. Coombs committed
689 690 691
* Removed build_py class from setup.py. According to 892f439d216e, this
  functionality was added to support upgrades from old Distribute versions,
  0.6.5 and 0.6.6.
Jason R. Coombs's avatar
Jason R. Coombs committed
692

Jason R. Coombs's avatar
Jason R. Coombs committed
693 694 695
12.4
----

696
* BB Pull Request #119: Restore writing of ``setup_requires`` to metadata
Jason R. Coombs's avatar
Jason R. Coombs committed
697 698
  (previously added in 8.4 and removed in 9.0).

Jason R. Coombs's avatar
Jason R. Coombs committed
699 700 701 702 703 704 705 706 707
12.3
----

* Documentation is now linked using the rst.linker package.
* Fix ``setuptools.command.easy_install.extract_wininst_cfg()``
  with Python 2.6 and 2.7.
* Issue #354. Added documentation on building setuptools
  documentation.

Jason R. Coombs's avatar
Jason R. Coombs committed
708 709 710 711 712 713 714 715
12.2
----

* Issue #345: Unload all modules under pkg_resources during
  ``ez_setup.use_setuptools()``.
* Issue #336: Removed deprecation from ``ez_setup.use_setuptools``,
  as it is clearly still used by buildout's bootstrap. ``ez_setup``
  remains deprecated for use by individual packages.
Jason R. Coombs's avatar
Jason R. Coombs committed
716
* Simplified implementation of ``ez_setup.use_setuptools``.
Jason R. Coombs's avatar
Jason R. Coombs committed
717

Jason R. Coombs's avatar
Jason R. Coombs committed
718 719 720
12.1
----

721
* BB Pull Request #118: Soften warning for non-normalized versions in
Jason R. Coombs's avatar
Jason R. Coombs committed
722 723
  Distribution.

Jason R. Coombs's avatar
Jason R. Coombs committed
724 725 726 727
12.0.5
------

* Issue #339: Correct Attribute reference in ``cant_write_to_target``.
Jason R. Coombs's avatar
Jason R. Coombs committed
728
* Issue #336: Deprecated ``ez_setup.use_setuptools``.
Jason R. Coombs's avatar
Jason R. Coombs committed
729

Jason R. Coombs's avatar
Jason R. Coombs committed
730 731 732 733 734
12.0.4
------

* Issue #335: Fix script header generation on Windows.

Jason R. Coombs's avatar
Jason R. Coombs committed
735 736 737 738 739
12.0.3
------

* Fixed incorrect class attribute in ``install_scripts``. Tests would be nice.

Jason R. Coombs's avatar
Jason R. Coombs committed
740 741 742 743 744 745
12.0.2
------

* Issue #331: Fixed ``install_scripts`` command on Windows systems corrupting
  the header.

746 747 748 749 750 751 752
12.0.1
------

* Restore ``setuptools.command.easy_install.sys_executable`` for pbr
  compatibility. For the future, tools should construct a CommandSpec
  explicitly.

Jason R. Coombs's avatar
Jason R. Coombs committed
753 754 755 756 757 758 759
12.0
----

* Issue #188: Setuptools now support multiple entities in the value for
  ``build.executable``, such that an executable of "/usr/bin/env my-python" may
  be specified. This means that systems with a specified executable whose name
  has spaces in the path must be updated to escape or quote that value.
760 761
* Deprecated ``easy_install.ScriptWriter.get_writer``, replaced by ``.best()``
  with slightly different semantics (no force_windows flag).
Jason R. Coombs's avatar
Jason R. Coombs committed
762

763 764 765 766 767 768
11.3.1
------

* Issue #327: Formalize and restore support for any printable character in an
  entry point name.

769 770 771 772 773 774 775 776 777 778 779 780 781
11.3
----

* Expose ``EntryPoint.resolve`` in place of EntryPoint._load, implementing the
  simple, non-requiring load. Deprecated all uses of ``EntryPoint._load``
  except for calling with no parameters, which is just a shortcut for
  ``ep.require(); ep.resolve();``.

  Apps currently invoking ``ep.load(require=False)`` should instead do the
  following if wanting to avoid the deprecating warning::

    getattr(ep, "resolve", lambda: ep.load(require=False))()

Jason R. Coombs's avatar
Jason R. Coombs committed
782 783 784 785 786
11.2
----

* Pip #2326: Report deprecation warning at stacklevel 2 for easier diagnosis.

Jason R. Coombs's avatar
Jason R. Coombs committed
787 788 789 790 791 792 793 794 795 796
11.1
----

* Issue #281: Since Setuptools 6.1 (Issue #268), a ValueError would be raised
  in certain cases where VersionConflict was raised with two arguments, which
  occurred in ``pkg_resources.WorkingSet.find``. This release adds support
  for indicating the dependent packages while maintaining support for
  a VersionConflict when no dependent package context is known. New unit tests
  now capture the expected interface.

Jason R. Coombs's avatar
Jason R. Coombs committed
797 798 799 800 801 802
11.0
----

* Interop #3: Upgrade to Packaging 15.0; updates to PEP 440 so that >1.7 does
  not exclude 1.7.1 but does exclude 1.7.0 and 1.7.0.post1.

803 804 805 806 807
10.2.1
------

* Issue #323: Fix regression in entry point name parsing.

Jason R. Coombs's avatar
Jason R. Coombs committed
808
10.2
809 810
----

Jason R. Coombs's avatar
Jason R. Coombs committed
811 812 813
* Deprecated use of EntryPoint.load(require=False). Passing a boolean to a
  function to select behavior is an anti-pattern. Instead use
  ``Entrypoint._load()``.
Jason R. Coombs's avatar
Jason R. Coombs committed
814 815
* Substantial refactoring of all unit tests. Tests are now much leaner and
  re-use a lot of fixtures and contexts for better clarity of purpose.
816

817 818 819
10.1
----

Jason R. Coombs's avatar
Jason R. Coombs committed
820 821
* Issue #320: Added a compatibility implementation of
  ``sdist._default_revctrl``
822 823 824
  so that systems relying on that interface do not fail (namely, Ubuntu 12.04
  and similar Debian releases).

Jason R. Coombs's avatar
Jason R. Coombs committed
825 826 827 828 829
10.0.1
------

* Issue #319: Fixed issue installing pure distutils packages.

Jason R. Coombs's avatar
Jason R. Coombs committed
830 831
10.0
----
Jason R. Coombs's avatar
Jason R. Coombs committed
832 833 834

* Issue #313: Removed built-in support for subversion. Projects wishing to
  retain support for subversion will need to use a third party library. The
835 836
  extant implementation is being ported to `setuptools_svn
  <https://pypi.python.org/pypi/setuptools_svn>`_.
Jason R. Coombs's avatar
Jason R. Coombs committed
837 838 839 840 841
* Issue #315: Updated setuptools to hide its own loaded modules during
  installation of another package. This change will enable setuptools to
  upgrade (or downgrade) itself even when its own metadata and implementation
  change.

Jason R. Coombs's avatar
Jason R. Coombs committed
842 843 844 845 846 847
9.1
---

* Prefer vendored packaging library `as recommended
  <https://github.com/jaraco/setuptools/commit/170657b68f4b92e7e1bf82f5e19a831f5744af67#commitcomment-9109448>`_.

848 849 850 851 852
9.0.1
-----

* Issue #312: Restored presence of pkg_resources API tests (doctest) to sdist.

Jason R. Coombs's avatar
Jason R. Coombs committed
853 854 855 856 857 858
9.0
---

* Issue #314: Disabled support for ``setup_requires`` metadata to avoid issue
  where Setuptools was unable to upgrade over earlier versions.

Jason R. Coombs's avatar
Jason R. Coombs committed
859 860 861
8.4
---

862
* BB Pull Request #106: Now write ``setup_requires`` metadata.
Jason R. Coombs's avatar
Jason R. Coombs committed
863

Jason R. Coombs's avatar
Jason R. Coombs committed
864 865 866 867 868 869
8.3
---

* Issue #311: Decoupled pkg_resources from setuptools once again.
  ``pkg_resources`` is now a package instead of a module.

870 871 872 873 874 875
8.2.1
-----

* Issue #306: Suppress warnings about Version format except in select scenarios
  (such as installation).

Jason R. Coombs's avatar
Jason R. Coombs committed
876
8.2
Jason R. Coombs's avatar
Jason R. Coombs committed
877 878
---

879
* BB Pull Request #85: Search egg-base when adding egg-info to manifest.
Jason R. Coombs's avatar
Jason R. Coombs committed
880

Jason R. Coombs's avatar
Jason R. Coombs committed
881 882 883 884 885 886 887 888 889
8.1
---

* Upgrade ``packaging`` to 14.5, giving preference to "rc" as designator for
  release candidates over "c".
* PEP-440 warnings are now raised as their own class,
  ``pkg_resources.PEP440Warning``, instead of RuntimeWarning.
* Disabled warnings on empty versions.

Jason R. Coombs's avatar
Jason R. Coombs committed
890 891 892 893 894 895 896 897 898
8.0.4
-----

* Upgrade ``packaging`` to 14.4, fixing an error where there is a
  different result for if 2.0.5 is contained within >2.0dev and >2.0.dev even
  though normalization rules should have made them equal.
* Issue #296: Add warning when a version is parsed as legacy. This warning will
  make it easier for developers to recognize deprecated version numbers.

Jason R. Coombs's avatar
Jason R. Coombs committed
899 900 901 902 903
8.0.3
-----

* Issue #296: Restored support for ``__hash__`` on parse_version results.

Jason R. Coombs's avatar
Jason R. Coombs committed
904 905 906 907 908 909
8.0.2
-----

* Issue #296: Restored support for ``__getitem__`` and sort operations on
  parse_version result.

Jason R. Coombs's avatar
Jason R. Coombs committed
910 911 912 913 914 915
8.0.1
-----

* Issue #296: Restore support for iteration over parse_version result, but
  deprecated that usage with a warning. Fixes failure with buildout.

916
8.0
917 918
---

919
* Implement PEP 440 within
920 921 922 923 924 925 926
  pkg_resources and setuptools. This change
  deprecates some version numbers such that they will no longer be installable
  without using the ``===`` escape hatch. See `the changes to test_resources
  <https://bitbucket.org/pypa/setuptools/commits/dcd552da643c4448056de84c73d56da6d70769d5#chg-setuptools/tests/test_resources.py>`_
  for specific examples of version numbers and specifiers that are no longer
  supported. Setuptools now "vendors" the `packaging
  <https://github.com/pypa/packaging>`_ library.
927

928 929
7.0
---
930

931 932 933 934 935 936
* Issue #80, Issue #209: Eggs that are downloaded for ``setup_requires``,
  ``test_requires``, etc. are now placed in a ``./.eggs`` directory instead of
  directly in the current directory. This choice of location means the files
  can be readily managed (removed, ignored). Additionally,
  later phases or invocations of setuptools will not detect the package as
  already installed and ignore it for permanent install (See #209).
937

938 939 940 941 942
  This change is indicated as backward-incompatible as installations that
  depend on the installation in the current directory will need to account for
  the new location. Systems that ignore ``*.egg`` will probably need to be
  adapted to ignore ``.eggs``. The files will need to be manually moved or
  will be retrieved again. Most use cases will require no attention.
943

Jason R. Coombs's avatar
Jason R. Coombs committed
944 945 946 947 948 949
6.1
---

* Issue #268: When resolving package versions, a VersionConflict now reports
  which package previously required the conflicting version.

950 951 952 953 954 955
6.0.2
-----

* Issue #262: Fixed regression in pip install due to egg-info directories
  being omitted. Re-opens Issue #118.

Jason R. Coombs's avatar
Jason R. Coombs committed
956 957 958 959 960 961
6.0.1
-----

* Issue #259: Fixed regression with namespace package handling on ``single
  version, externally managed`` installs.

Jason R. Coombs's avatar
Jason R. Coombs committed
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
6.0
---

* Issue #100: When building a distribution, Setuptools will no longer match
  default files using platform-dependent case sensitivity, but rather will
  only match the files if their case matches exactly. As a result, on Windows
  and other case-insensitive file systems, files with names such as
  'readme.txt' or 'README.TXT' will be omitted from the distribution and a
  warning will be issued indicating that 'README.txt' was not found. Other
  filenames affected are:

    - README.rst
    - README
    - setup.cfg
    - setup.py (or the script name)
    - test/test*.py

  Any users producing distributions with filenames that match those above
  case-insensitively, but not case-sensitively, should rename those files in
  their repository for better portability.
982
* BB Pull Request #72: When using ``single_version_externally_managed``, the
Jason R. Coombs's avatar
Jason R. Coombs committed
983
  exclusion list now includes Python 3.2 ``__pycache__`` entries.
984
* BB Pull Request #76 and BB Pull Request #78: lines in top_level.txt are now
Jason R. Coombs's avatar
Jason R. Coombs committed
985
  ordered deterministically.
Jason R. Coombs's avatar
Jason R. Coombs committed
986 987
* Issue #118: The egg-info directory is now no longer included in the list
  of outputs.
988
* Issue #258: Setuptools now patches distutils msvc9compiler to
Jason R. Coombs's avatar
Jason R. Coombs committed
989 990
  recognize the specially-packaged compiler package for easy extension module
  support on Python 2.6, 2.7, and 3.2.
Jason R. Coombs's avatar
Jason R. Coombs committed
991

992 993 994 995 996 997 998
5.8
---

* Issue #237: ``pkg_resources`` now uses explicit detection of Python 2 vs.
  Python 3, supporting environments where builtins have been patched to make
  Python 3 look more like Python 2.

999 1000 1001 1002 1003 1004 1005 1006 1007 1008
5.7
---

* Issue #240: Based on real-world performance measures against 5.4, zip
  manifests are now cached in all circumstances. The
  ``PKG_RESOURCES_CACHE_ZIP_MANIFESTS`` environment variable is no longer
  relevant. The observed "memory increase" referenced in the 5.4 release
  notes and detailed in Issue #154 was likely not an increase over the status
  quo, but rather only an increase over not storing the zip info at all.

1009 1010 1011 1012 1013 1014
5.6
---

* Issue #242: Use absolute imports in svn_utils to avoid issues if the
  installing package adds an xml module to the path.

Jason R. Coombs's avatar
Jason R. Coombs committed
1015 1016 1017 1018 1019
5.5.1
-----

* Issue #239: Fix typo in 5.5 such that fix did not take.

1020 1021 1022 1023 1024 1025 1026
5.5
---

* Issue #239: Setuptools now includes the setup_requires directive on
  Distribution objects and validates the syntax just like install_requires
  and tests_require directives.

1027 1028 1029 1030 1031
5.4.2
-----

* Issue #236: Corrected regression in execfile implementation for Python 2.6.

Jason R. Coombs's avatar
Jason R. Coombs committed
1032 1033 1034 1035 1036 1037
5.4.1
-----

* Python #7776: (ssl_support) Correct usage of host for validation when
  tunneling for HTTPS.

Jason R. Coombs's avatar
Jason R. Coombs committed
1038
5.4
1039 1040
---

1041 1042 1043 1044 1045 1046
* Issue #154: ``pkg_resources`` will now cache the zip manifests rather than
  re-processing the same file from disk multiple times, but only if the
  environment variable ``PKG_RESOURCES_CACHE_ZIP_MANIFESTS`` is set. Clients
  that package many modules in the same zip file will see some improvement
  in startup time by enabling this feature. This feature is not enabled by
  default because it causes a substantial increase in memory usage.
1047

Jason R. Coombs's avatar
Jason R. Coombs committed
1048 1049
5.3
---
1050

Jason R. Coombs's avatar
Jason R. Coombs committed
1051
* Issue #185: Make svn tagging work on the new style SVN metadata.
1052 1053 1054 1055
  Thanks cazabon!
* Prune revision control directories (e.g .svn) from base path
  as well as sub-directories.

Jason R. Coombs's avatar
Jason R. Coombs committed
1056 1057 1058 1059 1060 1061
5.2
---

* Added a `Developer Guide
  <https://pythonhosted.org/setuptools/developer-guide.html>`_ to the official
  documentation.
Jason R. Coombs's avatar
Jason R. Coombs committed
1062 1063
* Some code refactoring and cleanup was done with no intended behavioral
  changes.
1064 1065
* During install_egg_info, the generated lines for namespace package .pth
  files are now processed even during a dry run.
Jason R. Coombs's avatar
Jason R. Coombs committed
1066

Jason R. Coombs's avatar
Jason R. Coombs committed
1067 1068 1069 1070
5.1
---

* Issue #202: Implemented more robust cache invalidation for the ZipImporter,
Jason R. Coombs's avatar
Jason R. Coombs committed
1071
  building on the work in Issue #168. Special thanks to Jurko Gospodnetic and
Jason R. Coombs's avatar
Jason R. Coombs committed
1072 1073
  PJE.

Jason R. Coombs's avatar
Jason R. Coombs committed
1074 1075 1076 1077 1078
5.0.2
-----

* Issue #220: Restored script templates.

1079 1080 1081 1082 1083 1084
5.0.1
-----

* Renamed script templates to end with .tmpl now that they no longer need
  to be processed by 2to3. Fixes spurious syntax errors during build/install.

Jason R. Coombs's avatar
Jason R. Coombs committed
1085 1086 1087 1088
5.0
---

* Issue #218: Re-release of 3.8.1 to signal that it supersedes 4.x.
1089 1090
* Incidentally, script templates were updated not to include the triple-quote
  escaping.
Jason R. Coombs's avatar
Jason R. Coombs committed
1091 1092 1093

3.7.1 and 3.8.1 and 4.0.1
-------------------------
Jason R. Coombs's avatar
Jason R. Coombs committed
1094 1095

* Issue #213: Use legacy StringIO behavior for compatibility under pbr.
Jason R. Coombs's avatar
Jason R. Coombs committed
1096 1097
* Issue #218: Setuptools 3.8.1 superseded 4.0.1, and 4.x was removed
  from the available versions to install.
Jason R. Coombs's avatar
Jason R. Coombs committed
1098

Jason R. Coombs's avatar
Jason R. Coombs committed
1099 1100 1101 1102 1103 1104
4.0
---

* Issue #210: ``setup.py develop`` now copies scripts in binary mode rather
  than text mode, matching the behavior of the ``install`` command.

Jason R. Coombs's avatar
Jason R. Coombs committed
1105 1106 1107 1108 1109 1110
3.8
---

* Extend Issue #197 workaround to include all Python 3 versions prior to
  3.2.2.

Jason R. Coombs's avatar
Jason R. Coombs committed
1111 1112 1113 1114 1115
3.7
---

* Issue #193: Improved handling of Unicode filenames when building manifests.

1116 1117 1118 1119 1120 1121
3.6
---

* Issue #203: Honor proxy settings for Powershell downloader in the bootstrap
  routine.

Jason R. Coombs's avatar
Jason R. Coombs committed
1122 1123 1124 1125 1126 1127
3.5.2
-----

* Issue #168: More robust handling of replaced zip files and stale caches.
  Fixes ZipImportError complaining about a 'bad local header'.

1128 1129 1130 1131 1132 1133
3.5.1
-----

* Issue #199: Restored ``install._install`` for compatibility with earlier
  NumPy versions.

1134 1135 1136
3.5
---

Jason R. Coombs's avatar
Jason R. Coombs committed
1137 1138
* Issue #195: Follow symbolic links in find_packages (restoring behavior
  broken in 3.4).
1139 1140
* Issue #197: On Python 3.1, PKG-INFO is now saved in a UTF-8 encoding instead
  of ``sys.getpreferredencoding`` to match the behavior on Python 2.6-3.4.
Jason R. Coombs's avatar
Jason R. Coombs committed
1141 1142
* Issue #192: Preferred bootstrap location is now
  https://bootstrap.pypa.io/ez_setup.py (mirrored from former location).
1143

1144 1145 1146 1147 1148 1149
3.4.4
-----

* Issue #184: Correct failure where find_package over-matched packages
  when directory traversal isn't short-circuited.

1150 1151 1152 1153 1154
3.4.3
-----

* Issue #183: Really fix test command with Python 3.1.

1155 1156 1157 1158 1159
3.4.2
-----

* Issue #183: Fix additional regression in test command on Python 3.1.

1160 1161 1162 1163 1164
3.4.1
-----

* Issue #180: Fix regression in test command not caught by py.test-run tests.

Jason R. Coombs's avatar
Jason R. Coombs committed
1165
3.4
1166 1167
---

1168 1169
* Issue #176: Add parameter to the test command to support a custom test
  runner: --test-runner or -r.
1170 1171 1172 1173
* Issue #177: Now assume most common invocation to install command on
  platforms/environments without stack support (issuing a warning). Setuptools
  now installs naturally on IronPython. Behavior on CPython should be
  unchanged.
1174

1175 1176 1177 1178 1179
3.3
---

* Add ``include`` parameter to ``setuptools.find_packages()``.

1180 1181 1182
3.2
---

1183
* BB Pull Request #39: Add support for C++ targets from Cython ``.pyx`` files.
1184
* Issue #162: Update dependency on certifi to 1.0.1.
1185
* Issue #164: Update dependency on wincertstore to 0.2.
1186

Jason R. Coombs's avatar
Jason R. Coombs committed
1187 1188 1189 1190 1191 1192
3.1
---

* Issue #161: Restore Features functionality to allow backward compatibility
  (for Features) until the uses of that functionality is sufficiently removed.

1193 1194 1195 1196 1197
3.0.2
-----

* Correct typo in previous bugfix.

1198 1199 1200 1201 1202 1203
3.0.1
-----

* Issue #157: Restore support for Python 2.6 in bootstrap script where
  ``zipfile.ZipFile`` does not yet have support for context managers.

1204 1205 1206
3.0
---

Jason R. Coombs's avatar
Jason R. Coombs committed
1207 1208
* Issue #125: Prevent Subversion support from creating a ~/.subversion
  directory just for checking the presence of a Subversion repository.
1209 1210 1211 1212 1213 1214 1215 1216
* Issue #12: Namespace packages are now imported lazily.  That is, the mere
  declaration of a namespace package in an egg on ``sys.path`` no longer
  causes it to be imported when ``pkg_resources`` is imported.  Note that this
  change means that all of a namespace package's ``__init__.py`` files must
  include a ``declare_namespace()`` call in order to ensure that they will be
  handled properly at runtime.  In 2.x it was possible to get away without
  including the declaration, but only at the cost of forcing namespace
  packages to be imported early, which 3.0 no longer does.
1217 1218 1219 1220
* Issue #148: When building (bdist_egg), setuptools no longer adds
  ``__init__.py`` files to namespace packages. Any packages that rely on this
  behavior will need to create ``__init__.py`` files and include the
  ``declare_namespace()``.
1221 1222 1223 1224
* Issue #7: Setuptools itself is now distributed as a zip archive in addition to
  tar archive. ez_setup.py now uses zip archive. This approach avoids the potential
  security vulnerabilities presented by use of tar archives in ez_setup.py.
  It also leverages the security features added to ZipFile.extract in Python 2.7.4.
1225
* Issue #65: Removed deprecated Features functionality.
1226
* BB Pull Request #28: Remove backport of ``_bytecode_filenames`` which is
Jason R. Coombs's avatar
Jason R. Coombs committed
1227 1228
  available in Python 2.6 and later, but also has better compatibility with
  Python 3 environments.
1229
* Issue #156: Fix spelling of __PYVENV_LAUNCHER__ variable.
Jason R. Coombs's avatar
Jason R. Coombs committed
1230

Jason R. Coombs's avatar
Jason R. Coombs committed
1231 1232 1233 1234
2.2
---

* Issue #141: Restored fix for allowing setup_requires dependencies to
Jason R. Coombs's avatar
Jason R. Coombs committed
1235
  override installed dependencies during setup.
1236 1237
* Issue #128: Fixed issue where only the first dependency link was honored
  in a distribution where multiple dependency links were supplied.
Jason R. Coombs's avatar
Jason R. Coombs committed
1238

Jason R. Coombs's avatar
Jason R. Coombs committed
1239 1240 1241 1242 1243 1244
2.1.2
-----

* Issue #144: Read long_description using codecs module to avoid errors
  installing on systems where LANG=C.

Jason R. Coombs's avatar
Jason R. Coombs committed
1245 1246 1247 1248 1249 1250
2.1.1
-----

* Issue #139: Fix regression in re_finder for CVS repos (and maybe Git repos
  as well).

Jason R. Coombs's avatar
Jason R. Coombs committed
1251 1252
2.1
---
1253

Jason R. Coombs's avatar
Jason R. Coombs committed
1254
* Issue #129: Suppress inspection of ``*.whl`` files when searching for files
Jason R. Coombs's avatar
Jason R. Coombs committed
1255
  in a zip-imported file.
1256 1257
* Issue #131: Fix RuntimeError when constructing an egg fetcher.

1258 1259 1260 1261 1262
2.0.2
-----

* Fix NameError during installation with Python implementations (e.g. Jython)
  not containing parser module.
Jason R. Coombs's avatar
Jason R. Coombs committed
1263
* Fix NameError in ``sdist:re_finder``.
1264

1265 1266 1267 1268 1269
2.0.1
-----

* Issue #124: Fixed error in list detection in upload_docs.

1270 1271 1272
2.0
---

1273
* Issue #121: Exempt lib2to3 pickled grammars from DirectorySandbox.
1274 1275
* Issue #41: Dropped support for Python 2.4 and Python 2.5. Clients requiring
  setuptools for those versions of Python should use setuptools 1.x.
1276 1277 1278
* Removed ``setuptools.command.easy_install.HAS_USER_SITE``. Clients
  expecting this boolean variable should use ``site.ENABLE_USER_SITE``
  instead.
1279 1280
* Removed ``pkg_resources.ImpWrapper``. Clients that expected this class
  should use ``pkgutil.ImpImporter`` instead.
1281

1282 1283 1284 1285 1286 1287
1.4.2
-----

* Issue #116: Correct TypeError when reading a local package index on Python
  3.

1288 1289 1290 1291 1292 1293
1.4.1
-----

* Issue #114: Use ``sys.getfilesystemencoding`` for decoding config in
  ``bdist_wininst`` distributions.

1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
* Issue #105 and Issue #113: Establish a more robust technique for
  determining the terminal encoding::

    1. Try ``getpreferredencoding``
    2. If that returns US_ASCII or None, try the encoding from
       ``getdefaultlocale``. If that encoding was a "fallback" because Python
       could not figure it out from the environment or OS, encoding remains
       unresolved.
    3. If the encoding is resolved, then make sure Python actually implements
       the encoding.
    4. On the event of an error or unknown codec, revert to fallbacks
       (UTF-8 on Darwin, ASCII on everything else).
    5. On the encoding is 'mac-roman' on Darwin, use UTF-8 as 'mac-roman' was
       a bug on older Python releases.

    On a side note, it would seem that the encoding only matters for when SVN
    does not yet support ``--xml`` and when getting repository and svn version
    numbers. The ``--xml`` technique should yield UTF-8 according to some
    messages on the SVN mailing lists. So if the version numbers are always
    7-bit ASCII clean, it may be best to only support the file parsing methods
    for legacy SVN releases and support for SVN without the subprocess command
    would simple go away as support for the older SVNs does.

Jason R. Coombs's avatar
Jason R. Coombs committed
1317 1318 1319 1320 1321
1.4
---

* Issue #27: ``easy_install`` will now use credentials from .pypirc if
  present for connecting to the package index.
1322
* BB Pull Request #21: Omit unwanted newlines in ``package_index._encode_auth``
1323
  when the username/password pair length indicates wrapping.
Jason R. Coombs's avatar
Jason R. Coombs committed
1324

1325 1326 1327 1328 1329
1.3.2
-----

* Issue #99: Fix filename encoding issues in SVN support.

Jason R. Coombs's avatar
Jason R. Coombs committed
1330 1331 1332 1333 1334
1.3.1
-----

* Remove exuberant warning in SVN support when SVN is not used.

Jason R. Coombs's avatar
Jason R. Coombs committed
1335 1336 1337 1338 1339 1340 1341 1342
1.3
---

* Address security vulnerability in SSL match_hostname check as reported in
  Python #17997.
* Prefer `backports.ssl_match_hostname
  <https://pypi.python.org/pypi/backports.ssl_match_hostname>`_ for backport
  implementation if present.
Jason R. Coombs's avatar
Jason R. Coombs committed
1343
* Correct NameError in ``ssl_support`` module (``socket.error``).
Jason R. Coombs's avatar
Jason R. Coombs committed
1344

Jason R. Coombs's avatar
Jason R. Coombs committed
1345 1346 1347 1348 1349
1.2
---

* Issue #26: Add support for SVN 1.7. Special thanks to Philip Thiem for the
  contribution.
1350 1351 1352 1353
* Issue #93: Wheels are now distributed with every release. Note that as
  reported in Issue #108, as of Pip 1.4, scripts aren't installed properly
  from wheels. Therefore, if using Pip to install setuptools from a wheel,
  the ``easy_install`` command will not be available.
Jason R. Coombs's avatar
Jason R. Coombs committed
1354 1355
* Setuptools "natural" launcher support, introduced in 1.0, is now officially
  supported.
Jason R. Coombs's avatar
Jason R. Coombs committed
1356

Jason R. Coombs's avatar
Jason R. Coombs committed
1357 1358 1359 1360 1361 1362 1363
1.1.7
-----

* Fixed behavior of NameError handling in 'script template (dev).py' (script
  launcher for 'develop' installs).
* ``ez_setup.py`` now ensures partial downloads are cleaned up following
  a failed download.
1364 1365
* Distribute #363 and Issue #55: Skip an sdist test that fails on locales
  other than UTF-8.
Jason R. Coombs's avatar
Jason R. Coombs committed
1366

1367 1368 1369 1370 1371 1372
1.1.6
-----

* Distribute #349: ``sandbox.execfile`` now opens the target file in binary
  mode, thus honoring a BOM in the file when compiled.

Jason R. Coombs's avatar
Jason R. Coombs committed
1373 1374 1375 1376 1377
1.1.5
-----

* Issue #69: Second attempt at fix (logic was reversed).

Jason R. Coombs's avatar
Merge  
Jason R. Coombs committed
1378 1379 1380 1381 1382
1.1.4
-----

* Issue #77: Fix error in upload command (Python 2.4).

1383 1384 1385 1386 1387
1.1.3
-----

* Fix NameError in previous patch.

Jason R. Coombs's avatar
Jason R. Coombs committed
1388 1389 1390 1391 1392 1393
1.1.2
-----

* Issue #69: Correct issue where 404 errors are returned for URLs with
  fragments in them (such as #egg=).

1394 1395
1.1.1
-----
1396 1397 1398

* Issue #75: Add ``--insecure`` option to ez_setup.py to accommodate
  environments where a trusted SSL connection cannot be validated.
1399
* Issue #76: Fix AttributeError in upload command with Python 2.4.
1400

1401 1402 1403
1.1
---

1404
* Issue #71 (Distribute #333): EasyInstall now puts less emphasis on the
1405
  condition when a host is blocked via ``--allow-hosts``.
1406
* Issue #72: Restored Python 2.4 compatibility in ``ez_setup.py``.
1407

1408 1409 1410
1.0
---

1411 1412 1413 1414 1415 1416 1417 1418
* Issue #60: On Windows, Setuptools supports deferring to another launcher,
  such as Vinay Sajip's `pylauncher <https://bitbucket.org/pypa/pylauncher>`_
  (included with Python 3.3) to launch console and GUI scripts and not install
  its own launcher executables. This experimental functionality is currently
  only enabled if  the ``SETUPTOOLS_LAUNCHER`` environment variable is set to
  "natural". In the future, this behavior may become default, but only after
  it has matured and seen substantial adoption. The ``SETUPTOOLS_LAUNCHER``
  also accepts "executable" to force the default behavior of creating launcher
1419
  executables.
1420 1421 1422 1423
* Issue #63: Bootstrap script (ez_setup.py) now prefers Powershell, curl, or
  wget for retrieving the Setuptools tarball for improved security of the
  install. The script will still fall back to a simple ``urlopen`` on
  platforms that do not have these tools.
1424
* Issue #65: Deprecated the ``Features`` functionality.
1425 1426
* Issue #52: In ``VerifyingHTTPSConn``, handle a tunnelled (proxied)
  connection.
1427

1428
Backward-Incompatible Changes
1429
=============================
1430 1431 1432

This release includes a couple of backward-incompatible changes, but most if
not all users will find 1.0 a drop-in replacement for 0.9.
1433 1434 1435 1436 1437 1438 1439 1440

* Issue #50: Normalized API of environment marker support. Specifically,
  removed line number and filename from SyntaxErrors when returned from
  `pkg_resources.invalid_marker`. Any clients depending on the specific
  string representation of exceptions returned by that function may need to
  be updated to account for this change.
* Issue #50: SyntaxErrors generated by `pkg_resources.invalid_marker` are
  normalized for cross-implementation consistency.
1441 1442
* Removed ``--ignore-conflicts-at-my-risk`` and ``--delete-conflicting``
  options to easy_install. These options have been deprecated since 0.6a11.
1443

Jason R. Coombs's avatar
Jason R. Coombs committed
1444 1445 1446 1447 1448
0.9.8
-----

* Issue #53: Fix NameErrors in `_vcs_split_rev_from_url`.

Jason R. Coombs's avatar
Jason R. Coombs committed
1449 1450 1451 1452 1453
0.9.7
-----

* Issue #49: Correct AttributeError on PyPy where a hashlib.HASH object does
  not have a `.name` attribute.
1454 1455 1456
* Issue #34: Documentation now refers to bootstrap script in code repository
  referenced by bookmark.
* Add underscore-separated keys to environment markers (markerlib).
Jason R. Coombs's avatar
Jason R. Coombs committed
1457

1458 1459 1460 1461 1462 1463
0.9.6
-----

* Issue #44: Test failure on Python 2.4 when MD5 hash doesn't have a `.name`
  attribute.

Jason R. Coombs's avatar
Jason R. Coombs committed
1464 1465 1466 1467 1468
0.9.5
-----

* Python #17980: Fix security vulnerability in SSL certificate validation.

1469 1470 1471 1472 1473 1474
0.9.4
-----

* Issue #43: Fix issue (introduced in 0.9.1) with version resolution when
  upgrading over other releases of Setuptools.

1475 1476 1477 1478 1479
0.9.3
-----

* Issue #42: Fix new ``AttributeError`` introduced in last fix.

Jason R. Coombs's avatar
Jason R. Coombs committed
1480 1481 1482 1483 1484 1485
0.9.2
-----

* Issue #42: Fix regression where blank checksums would trigger an
  ``AttributeError``.

1486 1487 1488 1489
0.9.1
-----

* Distribute #386: Allow other positional and keyword arguments to os.open.
Jason R. Coombs's avatar
Jason R. Coombs committed
1490
* Corrected dependency on certifi mis-referenced in 0.9.
1491

1492 1493 1494 1495 1496
0.9
---

* `package_index` now validates hashes other than MD5 in download links.

Jason R. Coombs's avatar
Jason R. Coombs committed
1497 1498 1499 1500 1501 1502
0.8
---

* Code base now runs on Python 2.4 - Python 3.3 without Python 2to3
  conversion.

Jason R. Coombs's avatar
Jason R. Coombs committed
1503 1504 1505 1506 1507
0.7.8
-----

* Distribute #375: Yet another fix for yet another regression.

Jason R. Coombs's avatar
Jason R. Coombs committed
1508 1509 1510 1511
0.7.7
-----

* Distribute #375: Repair AttributeError created in last release (redo).
1512
* Issue #30: Added test for get_cache_path.
Jason R. Coombs's avatar
Jason R. Coombs committed
1513

Jason R. Coombs's avatar
Jason R. Coombs committed
1514 1515 1516 1517 1518
0.7.6
-----

* Distribute #375: Repair AttributeError created in last release.

Jason R. Coombs's avatar
Jason R. Coombs committed
1519 1520 1521 1522
0.7.5
-----

* Issue #21: Restore Python 2.4 compatibility in ``test_easy_install``.
Jason R. Coombs's avatar
Jason R. Coombs committed
1523 1524 1525 1526
* Distribute #375: Merged additional warning from Distribute 0.6.46.
* Now honor the environment variable
  ``SETUPTOOLS_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT`` in addition to the now
  deprecated ``DISTRIBUTE_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT``.
Jason R. Coombs's avatar
Jason R. Coombs committed
1527

1528 1529 1530 1531 1532
0.7.4
-----

* Issue #20: Fix comparison of parsed SVN version on Python 3.

1533 1534 1535
0.7.3
-----

1536
* Issue #1: Disable installation of Windows-specific files on non-Windows systems.
1537
* Use new sysconfig module with Python 2.7 or >=3.2.
1538

Jason R. Coombs's avatar
Jason R. Coombs committed
1539 1540 1541
0.7.2
-----

1542
* Issue #14: Use markerlib when the `parser` module is not available.
Jason R. Coombs's avatar
Jason R. Coombs committed
1543 1544
* Issue #10: ``ez_setup.py`` now uses HTTPS to download setuptools from PyPI.

Jason R. Coombs's avatar
Jason R. Coombs committed
1545 1546 1547 1548 1549
0.7.1
-----

* Fix NameError (Issue #3) again - broken in bad merge.

1550 1551 1552
0.7
---

1553
* Merged Setuptools and Distribute. See docs/merge.txt for details.
1554 1555 1556 1557

Added several features that were slated for setuptools 0.6c12:

* Index URL now defaults to HTTPS.
1558 1559 1560 1561 1562 1563
* Added experimental environment marker support. Now clients may designate a
  PEP-426 environment marker for "extra" dependencies. Setuptools uses this
  feature in ``setup.py`` for optional SSL and certificate validation support
  on older platforms. Based on Distutils-SIG discussions, the syntax is
  somewhat tentative. There should probably be a PEP with a firmer spec before
  the feature should be considered suitable for use.
1564 1565 1566
* Added support for SSL certificate validation when installing packages from
  an HTTPS service.

Jason R. Coombs's avatar
Jason R. Coombs committed
1567 1568 1569 1570 1571
0.7b4
-----

* Issue #3: Fixed NameError in SSL support.

1572
0.6.49
1573 1574 1575 1576
------

* Move warning check in ``get_cache_path`` to follow the directory creation
  to avoid errors when the cache path does not yet exist. Fixes the error
1577
  reported in Distribute #375.
1578

Jason R. Coombs's avatar
Jason R. Coombs committed
1579 1580 1581 1582 1583 1584
0.6.48
------

* Correct AttributeError in ``ResourceManager.get_cache_path`` introduced in
  0.6.46 (redo).

Jason R. Coombs's avatar
Jason R. Coombs committed
1585 1586 1587 1588 1589 1590
0.6.47
------

* Correct AttributeError in ``ResourceManager.get_cache_path`` introduced in
  0.6.46.

Jason R. Coombs's avatar
Jason R. Coombs committed
1591 1592 1593
0.6.46
------

1594
* Distribute #375: Issue a warning if the PYTHON_EGG_CACHE or otherwise
Jason R. Coombs's avatar
Jason R. Coombs committed
1595 1596 1597
  customized egg cache location specifies a directory that's group- or
  world-writable.

1598 1599 1600
0.6.45
------

1601
* Distribute #379: ``distribute_setup.py`` now traps VersionConflict as well,
1602 1603
  restoring ability to upgrade from an older setuptools version.

1604 1605 1606 1607 1608 1609
0.6.44
------

* ``distribute_setup.py`` has been updated to allow Setuptools 0.7 to
  satisfy use_setuptools.

Jason R. Coombs's avatar
Jason R. Coombs committed
1610 1611 1612
0.6.43
------

1613
* Distribute #378: Restore support for Python 2.4 Syntax (regression in 0.6.42).
Jason R. Coombs's avatar
Jason R. Coombs committed
1614

1615 1616 1617 1618
0.6.42
------

* External links finder no longer yields duplicate links.
1619
* Distribute #337: Moved site.py to setuptools/site-patch.py (graft of very old
Jason R. Coombs's avatar
Jason R. Coombs committed
1620
  patch from setuptools trunk which inspired PR #31).
1621

1622 1623 1624
0.6.41
------

1625
* Distribute #27: Use public api for loading resources from zip files rather than
1626
  the private method `_zip_directory_cache`.
1627 1628 1629
* Added a new function ``easy_install.get_win_launcher`` which may be used by
  third-party libraries such as buildout to get a suitable script launcher.

1630 1631 1632
0.6.40
------

1633
* Distribute #376: brought back cli.exe and gui.exe that were deleted in the
Jason R. Coombs's avatar
Jason R. Coombs committed
1634 1635
  previous release.

1636 1637 1638 1639 1640 1641 1642
0.6.39
------

* Add support for console launchers on ARM platforms.
* Fix possible issue in GUI launchers where the subsystem was not supplied to
  the linker.
* Launcher build script now refactored for robustness.
1643
* Distribute #375: Resources extracted from a zip egg to the file system now also
1644 1645
  check the contents of the file against the zip contents during each
  invocation of get_resource_filename.
1646

Jason R. Coombs's avatar
Jason R. Coombs committed
1647 1648 1649
0.6.38
------

1650
* Distribute #371: The launcher manifest file is now installed properly.
Jason R. Coombs's avatar
Jason R. Coombs committed
1651

1652 1653 1654
0.6.37
------

1655
* Distribute #143: Launcher scripts, including easy_install itself, are now
1656 1657 1658 1659 1660
  accompanied by a manifest on 32-bit Windows environments to avoid the
  Installer Detection Technology and thus undesirable UAC elevation described
  in `this Microsoft article
  <http://technet.microsoft.com/en-us/library/cc709628%28WS.10%29.aspx>`_.

1661 1662
0.6.36
------
1663

1664
* BB Pull Request #35: In Buildout #64, it was reported that
1665 1666 1667 1668
  under Python 3, installation of distutils scripts could attempt to copy
  the ``__pycache__`` directory as a file, causing an error, apparently only
  under Windows. Easy_install now skips all directories when processing
  metadata scripts.
1669

1670 1671 1672
0.6.35
------

1673

1674 1675 1676
Note this release is backward-incompatible with distribute 0.6.23-0.6.34 in
how it parses version numbers.

1677
* Distribute #278: Restored compatibility with distribute 0.6.22 and setuptools
1678 1679 1680
  0.6. Updated the documentation to match more closely with the version
  parsing as intended in setuptools 0.6.

1681 1682
0.6.34
------
1683

1684
* Distribute #341: 0.6.33 fails to build under Python 2.4.
1685

1686 1687 1688 1689
0.6.33
------

* Fix 2 errors with Jython 2.5.
1690
* Fix 1 failure with Jython 2.5 and 2.7.
1691
* Disable workaround for Jython scripts on Linux systems.
1692
* Distribute #336: `setup.py` no longer masks failure exit code when tests fail.
1693 1694 1695
* Fix issue in pkg_resources where try/except around a platform-dependent
  import would trigger hook load failures on Mercurial. See pull request 32
  for details.
1696
* Distribute #341: Fix a ResourceWarning.
1697

1698 1699 1700 1701
0.6.32
------

* Fix test suite with Python 2.6.
1702
* Fix some DeprecationWarnings and ResourceWarnings.
1703
* Distribute #335: Backed out `setup_requires` superceding installed requirements
Jason R. Coombs's avatar
Jason R. Coombs committed
1704
  until regression can be addressed.
1705

1706 1707 1708
0.6.31
------

1709 1710
* Distribute #303: Make sure the manifest only ever contains UTF-8 in Python 3.
* Distribute #329: Properly close files created by tests for compatibility with
Jason R. Coombs's avatar
Jason R. Coombs committed
1711
  Jython.
1712 1713
* Work around Jython #1980 and Jython #1981.
* Distribute #334: Provide workaround for packages that reference `sys.__stdout__`
1714 1715 1716 1717 1718 1719
  such as numpy does. This change should address
  `virtualenv #359 <https://github.com/pypa/virtualenv/issues/359>`_ as long
  as the system encoding is UTF-8 or the IO encoding is specified in the
  environment, i.e.::

     PYTHONIOENCODING=utf8 pip install numpy
1720

1721
* Fix for encoding issue when installing from Windows executable on Python 3.
1722
* Distribute #323: Allow `setup_requires` requirements to supercede installed
Jason R. Coombs's avatar
Jason R. Coombs committed
1723 1724 1725 1726 1727 1728
  requirements. Added some new keyword arguments to existing pkg_resources
  methods. Also had to updated how __path__ is handled for namespace packages
  to ensure that when a new egg distribution containing a namespace package is
  placed on sys.path, the entries in __path__ are found in the same order they
  would have been in had that egg been on the path when pkg_resources was
  first imported.
1729

Jason R. Coombs's avatar
Jason R. Coombs committed
1730 1731 1732
0.6.30
------

1733
* Distribute #328: Clean up temporary directories in distribute_setup.py.
Jason R. Coombs's avatar
Jason R. Coombs committed
1734 1735
* Fix fatal bug in distribute_setup.py.

1736 1737 1738
0.6.29
------

1739
* BB Pull Request #14: Honor file permissions in zip files.
1740
* Distribute #327: Merged pull request #24 to fix a dependency problem with pip.
Stefan H. Holek's avatar
Stefan H. Holek committed
1741
* Merged pull request #23 to fix https://github.com/pypa/virtualenv/issues/301.
Stefan H. Holek's avatar
Stefan H. Holek committed
1742 1743
* If Sphinx is installed, the `upload_docs` command now runs `build_sphinx`
  to produce uploadable documentation.
1744 1745 1746 1747 1748 1749 1750 1751 1752
* Distribute #326: `upload_docs` provided mangled auth credentials under Python 3.
* Distribute #320: Fix check for "createable" in distribute_setup.py.
* Distribute #305: Remove a warning that was triggered during normal operations.
* Distribute #311: Print metadata in UTF-8 independent of platform.
* Distribute #303: Read manifest file with UTF-8 encoding under Python 3.
* Distribute #301: Allow to run tests of namespace packages when using 2to3.
* Distribute #304: Prevent import loop in site.py under Python 3.3.
* Distribute #283: Reenable scanning of `*.pyc` / `*.pyo` files on Python 3.3.
* Distribute #299: The develop command didn't work on Python 3, when using 2to3,
Lennart Regebro's avatar
Lennart Regebro committed
1753 1754 1755
  as the egg link would go to the Python 2 source. Linking to the 2to3'd code
  in build/lib makes it work, although you will have to rebuild the module
  before testing it.
1756 1757 1758 1759 1760 1761
* Distribute #306: Even if 2to3 is used, we build in-place under Python 2.
* Distribute #307: Prints the full path when .svn/entries is broken.
* Distribute #313: Support for sdist subcommands (Python 2.7)
* Distribute #314: test_local_index() would fail an OS X.
* Distribute #310: Non-ascii characters in a namespace __init__.py causes errors.
* Distribute #218: Improved documentation on behavior of `package_data` and
Jason R. Coombs's avatar
Jason R. Coombs committed
1762 1763
  `include_package_data`. Files indicated by `package_data` are now included
  in the manifest.
Jason R. Coombs's avatar
Jason R. Coombs committed
1764 1765
* `distribute_setup.py` now allows a `--download-base` argument for retrieving
  distribute from a specified location.
1766

Jason R. Coombs's avatar
Jason R. Coombs committed
1767 1768 1769
0.6.28
------

1770
* Distribute #294: setup.py can now be invoked from any directory.
Jason R. Coombs's avatar
Jason R. Coombs committed
1771
* Scripts are now installed honoring the umask.
1772
* Added support for .dist-info directories.
1773
* Distribute #283: Fix and disable scanning of `*.pyc` / `*.pyo` files on
1774
  Python 3.3.
Jason R. Coombs's avatar
Jason R. Coombs committed
1775

Jason R. Coombs's avatar
Jason R. Coombs committed
1776 1777 1778
0.6.27
------

1779
* Support current snapshots of CPython 3.3.
Jason R. Coombs's avatar
Jason R. Coombs committed
1780
* Distribute now recognizes README.rst as a standard, default readme file.
1781 1782
* Exclude 'encodings' modules when removing modules from sys.modules.
  Workaround for #285.
1783
* Distribute #231: Don't fiddle with system python when used with buildout
Jason R. Coombs's avatar
Merge  
Jason R. Coombs committed
1784
  (bootstrap.py)
Jason R. Coombs's avatar
Jason R. Coombs committed
1785

Jason R. Coombs's avatar
Jason R. Coombs committed
1786 1787 1788
0.6.26
------

1789 1790
* Distribute #183: Symlinked files are now extracted from source distributions.
* Distribute #227: Easy_install fetch parameters are now passed during the
Jason R. Coombs's avatar
Jason R. Coombs committed
1791 1792
  installation of a source distribution; now fulfillment of setup_requires
  dependencies will honor the parameters passed to easy_install.
Jason R. Coombs's avatar
Jason R. Coombs committed
1793

1794 1795 1796
0.6.25
------

1797 1798
* Distribute #258: Workaround a cache issue
* Distribute #260: distribute_setup.py now accepts the --user parameter for
1799
  Python 2.6 and later.
1800
* Distribute #262: package_index.open_with_auth no longer throws LookupError
1801
  on Python 3.
1802
* Distribute #269: AttributeError when an exception occurs reading Manifest.in
1803
  on late releases of Python.
1804
* Distribute #272: Prevent TypeError when namespace package names are unicode
1805 1806
  and single-install-externally-managed is used. Also fixes PIP issue
  449.
1807
* Distribute #273: Legacy script launchers now install with Python2/3 support.
1808

1809 1810 1811
0.6.24
------

1812
* Distribute #249: Added options to exclude 2to3 fixers
1813

guyroz's avatar
guyroz committed
1814 1815 1816
0.6.23
------

1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
* Distribute #244: Fixed a test
* Distribute #243: Fixed a test
* Distribute #239: Fixed a test
* Distribute #240: Fixed a test
* Distribute #241: Fixed a test
* Distribute #237: Fixed a test
* Distribute #238: easy_install now uses 64bit executable wrappers on 64bit Python
* Distribute #208: Fixed parsed_versions, it now honors post-releases as noted in the documentation
* Distribute #207: Windows cli and gui wrappers pass CTRL-C to child python process
* Distribute #227: easy_install now passes its arguments to setup.py bdist_egg
* Distribute #225: Fixed a NameError on Python 2.5, 2.4
Tarek Ziade's avatar
Tarek Ziade committed
1828

1829 1830 1831
0.6.21
------

1832
* Distribute #225: FIxed a regression on py2.4
1833

Tarek Ziade's avatar
Tarek Ziade committed
1834 1835 1836
0.6.20
------

1837 1838 1839
* Distribute #135: Include url in warning when processing URLs in package_index.
* Distribute #212: Fix issue where easy_instal fails on Python 3 on windows installer.
* Distribute #213: Fix typo in documentation.
Tarek Ziade's avatar
Tarek Ziade committed
1840

Tarek Ziade's avatar
Tarek Ziade committed
1841 1842 1843
0.6.19
------

1844
* Distribute #206: AttributeError: 'HTTPMessage' object has no attribute 'getheaders'
1845

Tarek Ziade's avatar
Tarek Ziade committed
1846 1847 1848
0.6.18
------

1849
* Distribute #210: Fixed a regression introduced by Distribute #204 fix.
Tarek Ziade's avatar
Tarek Ziade committed
1850

1851 1852 1853
0.6.17
------

1854 1855
* Support 'DISTRIBUTE_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT' environment
  variable to allow to disable installation of easy_install-${version} script.
1856
* Support Python >=3.1.4 and >=3.2.1.
1857
* Distribute #204: Don't try to import the parent of a namespace package in
Tarek Ziade's avatar
Tarek Ziade committed
1858
  declare_namespace
1859 1860
* Distribute #196: Tolerate responses with multiple Content-Length headers
* Distribute #205: Sandboxing doesn't preserve working_set. Leads to setup_requires
Tarek Ziade's avatar
Tarek Ziade committed
1861
  problems.
1862

1863 1864 1865
0.6.16
------

1866 1867
* Builds sdist gztar even on Windows (avoiding Distribute #193).
* Distribute #192: Fixed metadata omitted on Windows when package_dir
Jason R. Coombs's avatar
Jason R. Coombs committed
1868
  specified with forward-slash.
1869 1870
* Distribute #195: Cython build support.
* Distribute #200: Issues with recognizing 64-bit packages on Windows.
1871

1872 1873 1874 1875
0.6.15
------

* Fixed typo in bdist_egg
Lennart Regebro's avatar
Lennart Regebro committed
1876
* Several issues under Python 3 has been solved.
1877
* Distribute #146: Fixed missing DLL files after easy_install of windows exe package.
1878

1879 1880 1881
0.6.14
------

1882 1883 1884
* Distribute #170: Fixed unittest failure. Thanks to Toshio.
* Distribute #171: Fixed race condition in unittests cause deadlocks in test suite.
* Distribute #143: Fixed a lookup issue with easy_install.
Tarek Ziade's avatar
Tarek Ziade committed
1885
  Thanks to David and Zooko.
1886
* Distribute #174: Fixed the edit mode when its used with setuptools itself
1887

Tarek Ziade's avatar
Tarek Ziade committed
1888 1889 1890
0.6.13
------

1891 1892 1893
* Distribute #160: 2.7 gives ValueError("Invalid IPv6 URL")
* Distribute #150: Fixed using ~/.local even in a --no-site-packages virtualenv
* Distribute #163: scan index links before external links, and don't use the md5 when
1894
  comparing two distributions
Tarek Ziade's avatar
Tarek Ziade committed
1895

Tarek Ziade's avatar
Tarek Ziade committed
1896 1897 1898
0.6.12
------

1899
* Distribute #149: Fixed various failures on 2.3/2.4
Tarek Ziade's avatar
Tarek Ziade committed
1900

tarek's avatar
tarek committed
1901 1902 1903
0.6.11
------

1904
* Found another case of SandboxViolation - fixed
1905
* Distribute #15 and Distribute #48: Introduced a socket timeout of 15 seconds on url openings
tarek's avatar
tarek committed
1906
* Added indexsidebar.html into MANIFEST.in
1907 1908 1909 1910
* Distribute #108: Fixed TypeError with Python3.1
* Distribute #121: Fixed --help install command trying to actually install.
* Distribute #112: Added an os.makedirs so that Tarek's solution will work.
* Distribute #133: Added --no-find-links to easy_install
1911
* Added easy_install --user
1912 1913 1914 1915
* Distribute #100: Fixed develop --user not taking '.' in PYTHONPATH into account
* Distribute #134: removed spurious UserWarnings. Patch by VanLindberg
* Distribute #138: cant_write_to_target error when setup_requires is used.
* Distribute #147: respect the sys.dont_write_bytecode flag
tarek's avatar
tarek committed
1916

tarek's avatar
tarek committed
1917 1918 1919 1920 1921 1922 1923
0.6.10
------

* Reverted change made for the DistributionNotFound exception because
  zc.buildout uses the exception message to get the name of the
  distribution.

1924 1925 1926
0.6.9
-----

1927 1928
* Distribute #90: unknown setuptools version can be added in the working set
* Distribute #87: setupt.py doesn't try to convert distribute_setup.py anymore
1929
  Initial Patch by arfrever.
1930 1931
* Distribute #89: added a side bar with a download link to the doc.
* Distribute #86: fixed missing sentence in pkg_resources doc.
1932
* Added a nicer error message when a DistributionNotFound is raised.
1933 1934 1935 1936
* Distribute #80: test_develop now works with Python 3.1
* Distribute #93: upload_docs now works if there is an empty sub-directory.
* Distribute #70: exec bit on non-exec files
* Distribute #99: now the standalone easy_install command doesn't uses a
1937 1938 1939
  "setup.cfg" if any exists in the working directory. It will use it
  only if triggered by ``install_requires`` from a setup.py call
  (install, develop, etc).
1940 1941
* Distribute #101: Allowing ``os.devnull`` in Sandbox
* Distribute #92: Fixed the "no eggs" found error with MacPort
1942
  (platform.mac_ver() fails)
1943
* Distribute #103: test_get_script_header_jython_workaround not run
1944
  anymore under py3 with C or POSIX local. Contributed by Arfrever.
1945
* Distribute #104: remvoved the assertion when the installation fails,
1946
  with a nicer message for the end user.
1947
* Distribute #100: making sure there's no SandboxViolation when
1948
  the setup script patches setuptools.
1949

tarek's avatar
tarek committed
1950 1951 1952
0.6.8
-----

1953
* Added "check_packages" in dist. (added in Setuptools 0.6c11)
tarek's avatar
tarek committed
1954
* Fixed the DONT_PATCH_SETUPTOOLS state.
1955

tarek's avatar
tarek committed
1956 1957 1958
0.6.7
-----

1959 1960
* Distribute #58: Added --user support to the develop command
* Distribute #11: Generated scripts now wrap their call to the script entry point
1961
  in the standard "if name == 'main'"
tarek's avatar
tarek committed
1962 1963
* Added the 'DONT_PATCH_SETUPTOOLS' environment variable, so virtualenv
  can drive an installation that doesn't patch a global setuptools.
1964 1965 1966 1967
* Reviewed unladen-swallow specific change from
  http://code.google.com/p/unladen-swallow/source/detail?spec=svn875&r=719
  and determined that it no longer applies. Distribute should work fine with
  Unladen Swallow 2009Q3.
1968
* Distribute #21: Allow PackageIndex.open_url to gracefully handle all cases of a
1969
  httplib.HTTPException instead of just InvalidURL and BadStatusLine.
1970 1971
* Removed virtual-python.py from this distribution and updated documentation
  to point to the actively maintained virtualenv instead.
1972
* Distribute #64: use_setuptools no longer rebuilds the distribute egg every
1973 1974 1975 1976
  time it is run
* use_setuptools now properly respects the requested version
* use_setuptools will no longer try to import a distribute egg for the
  wrong Python version
1977 1978
* Distribute #74: no_fake should be True by default.
* Distribute #72: avoid a bootstrapping issue with easy_install -U
tarek's avatar
tarek committed
1979

tarek's avatar
tarek committed
1980 1981 1982
0.6.6
-----

Reinout van Rees's avatar
Reinout van Rees committed
1983 1984
* Unified the bootstrap file so it works on both py2.x and py3k without 2to3
  (patch by Holger Krekel)
tarek's avatar
tarek committed
1985

tarek's avatar
tarek committed
1986 1987 1988
0.6.5
-----

1989
* Distribute #65: cli.exe and gui.exe are now generated at build time,
1990 1991
  depending on the platform in use.

1992
* Distribute #67: Fixed doc typo (PEP 381/PEP 382).
tarek's avatar
tarek committed
1993

1994
* Distribute no longer shadows setuptools if we require a 0.7-series
1995 1996
  setuptools.  And an error is raised when installing a 0.7 setuptools with
  distribute.
1997

Reinout van Rees's avatar
Reinout van Rees committed
1998 1999 2000
* When run from within buildout, no attempt is made to modify an existing
  setuptools egg, whether in a shared egg directory or a system setuptools.

2001 2002
* Fixed a hole in sandboxing allowing builtin file to write outside of
  the sandbox.
tarek's avatar
tarek committed
2003

tarek's avatar
tarek committed
2004 2005 2006
0.6.4
-----

tarek's avatar
tarek committed
2007
* Added the generation of `distribute_setup_3k.py` during the release.
2008
  This closes Distribute #52.
tarek's avatar
tarek committed
2009

2010
* Added an upload_docs command to easily upload project documentation to
2011
  PyPI's https://pythonhosted.org. This close issue Distribute #56.
tarek's avatar
tarek committed
2012

tarek's avatar
tarek committed
2013 2014
* Fixed a bootstrap bug on the use_setuptools() API.

tarek's avatar
tarek committed
2015 2016 2017
0.6.3
-----

agronholm's avatar
agronholm committed
2018 2019 2020 2021 2022 2023 2024
setuptools
==========

* Fixed a bunch of calls to file() that caused crashes on Python 3.

bootstrapping
=============
tarek's avatar
tarek committed
2025

agronholm's avatar
agronholm committed
2026
* Fixed a bug in sorting that caused bootstrap to fail on Python 3.
tarek's avatar
tarek committed
2027

tarek's avatar
tarek committed
2028 2029 2030
0.6.2
-----

2031 2032 2033
setuptools
==========

agronholm's avatar
agronholm committed
2034
* Added Python 3 support; see docs/python3.txt.
2035
  This closes Old Setuptools #39.
2036 2037

* Added option to run 2to3 automatically when installing on Python 3.
2038
  This closes issue Distribute #31.
2039

2040
* Fixed invalid usage of requirement.parse, that broke develop -d.
2041
  This closes Old Setuptools #44.
2042 2043

* Fixed script launcher for 64-bit Windows.
2044
  This closes Old Setuptools #2.
2045

tarek's avatar
tarek committed
2046
* KeyError when compiling extensions.
2047
  This closes Old Setuptools #41.
2048

agronholm's avatar
agronholm committed
2049 2050
bootstrapping
=============
2051

2052
* Fixed bootstrap not working on Windows. This closes issue Distribute #49.
tarek's avatar
tarek committed
2053

2054
* Fixed 2.6 dependencies. This closes issue Distribute #50.
tarek's avatar
tarek committed
2055 2056

* Make sure setuptools is patched when running through easy_install
2057
  This closes Old Setuptools #40.
tarek's avatar
tarek committed
2058

tarek's avatar
tarek committed
2059 2060 2061
0.6.1
-----

2062 2063 2064 2065
setuptools
==========

* package_index.urlopen now catches BadStatusLine and malformed url errors.
2066
  This closes Distribute #16 and Distribute #18.
2067

2068
* zip_ok is now False by default. This closes Old Setuptools #33.
tarek's avatar
tarek committed
2069

2070
* Fixed invalid URL error catching. Old Setuptools #20.
2071

2072
* Fixed invalid bootstraping with easy_install installation (Distribute #40).
tarek's avatar
typo  
tarek committed
2073
  Thanks to Florian Schulze for the help.
tarek's avatar
tarek committed
2074 2075 2076 2077

* Removed buildout/bootstrap.py. A new repository will create a specific
  bootstrap.py script.

tarek's avatar
tarek committed
2078

agronholm's avatar
agronholm committed
2079 2080
bootstrapping
=============
tarek's avatar
tarek committed
2081 2082 2083

* The boostrap process leave setuptools alone if detected in the system
  and --root or --prefix is provided, but is not in the same location.
2084
  This closes Distribute #10.
tarek's avatar
tarek committed
2085

tarek's avatar
tarek committed
2086
0.6
tarek's avatar
tarek committed
2087
---
tarek's avatar
tarek committed
2088

2089
setuptools
tarek's avatar
tarek committed
2090
==========
2091

2092
* Packages required at build time where not fully present at install time.
2093
  This closes Distribute #12.
tarek's avatar
tarek committed
2094

2095
* Protected against failures in tarfile extraction. This closes Distribute #10.
2096

2097
* Made Jython api_tests.txt doctest compatible. This closes Distribute #7.
2098

2099
* sandbox.py replaced builtin type file with builtin function open. This
2100
  closes Distribute #6.
2101

2102
* Immediately close all file handles. This closes Distribute #3.
2103

2104
* Added compatibility with Subversion 1.6. This references Distribute #1.
2105 2106

pkg_resources
tarek's avatar
tarek committed
2107
=============
2108

2109
* Avoid a call to /usr/bin/sw_vers on OSX and use the official platform API
2110
  instead. Based on a patch from ronaldoussoren. This closes issue #5.
2111

2112
* Fixed a SandboxViolation for mkdir that could occur in certain cases.
2113
  This closes Distribute #13.
2114

tarek's avatar
tarek committed
2115
* Allow to find_on_path on systems with tight permissions to fail gracefully.
2116
  This closes Distribute #9.
2117

tarek's avatar
tarek committed
2118
* Corrected inconsistency between documentation and code of add_entry.
2119
  This closes Distribute #8.
2120

2121
* Immediately close all file handles. This closes Distribute #3.
2122 2123

easy_install
tarek's avatar
tarek committed
2124
============
2125

2126
* Immediately close all file handles. This closes Distribute #3.
2127

2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478
0.6c9
-----

 * Fixed a missing files problem when using Windows source distributions on
   non-Windows platforms, due to distutils not handling manifest file line
   endings correctly.

 * Updated Pyrex support to work with Pyrex 0.9.6 and higher.

 * Minor changes for Jython compatibility, including skipping tests that can't
   work on Jython.

 * Fixed not installing eggs in ``install_requires`` if they were also used for
   ``setup_requires`` or ``tests_require``.

 * Fixed not fetching eggs in ``install_requires`` when running tests.

 * Allow ``ez_setup.use_setuptools()`` to upgrade existing setuptools
   installations when called from a standalone ``setup.py``.

 * Added a warning if a namespace package is declared, but its parent package
   is not also declared as a namespace.

 * Support Subversion 1.5

 * Removed use of deprecated ``md5`` module if ``hashlib`` is available

 * Fixed ``bdist_wininst upload`` trying to upload the ``.exe`` twice

 * Fixed ``bdist_egg`` putting a ``native_libs.txt`` in the source package's
   ``.egg-info``, when it should only be in the built egg's ``EGG-INFO``.

 * Ensure that _full_name is set on all shared libs before extensions are
   checked for shared lib usage.  (Fixes a bug in the experimental shared
   library build support.)

 * Fix to allow unpacked eggs containing native libraries to fail more
   gracefully under Google App Engine (with an ``ImportError`` loading the
   C-based module, instead of getting a ``NameError``).

0.6c7
-----

 * Fixed ``distutils.filelist.findall()`` crashing on broken symlinks, and
   ``egg_info`` command failing on new, uncommitted SVN directories.

 * Fix import problems with nested namespace packages installed via
   ``--root`` or ``--single-version-externally-managed``, due to the
   parent package not having the child package as an attribute.

0.6c6
-----

 * Added ``--egg-path`` option to ``develop`` command, allowing you to force
   ``.egg-link`` files to use relative paths (allowing them to be shared across
   platforms on a networked drive).

 * Fix not building binary RPMs correctly.

 * Fix "eggsecutables" (such as setuptools' own egg) only being runnable with
   bash-compatible shells.

 * Fix ``#!`` parsing problems in Windows ``.exe`` script wrappers, when there
   was whitespace inside a quoted argument or at the end of the ``#!`` line
   (a regression introduced in 0.6c4).

 * Fix ``test`` command possibly failing if an older version of the project
   being tested was installed on ``sys.path`` ahead of the test source
   directory.

 * Fix ``find_packages()`` treating ``ez_setup`` and directories with ``.`` in
   their names as packages.

0.6c5
-----

 * Fix uploaded ``bdist_rpm`` packages being described as ``bdist_egg``
   packages under Python versions less than 2.5.

 * Fix uploaded ``bdist_wininst`` packages being described as suitable for
   "any" version by Python 2.5, even if a ``--target-version`` was specified.

0.6c4
-----

 * Overhauled Windows script wrapping to support ``bdist_wininst`` better.
   Scripts installed with ``bdist_wininst`` will always use ``#!python.exe`` or
   ``#!pythonw.exe`` as the executable name (even when built on non-Windows
   platforms!), and the wrappers will look for the executable in the script's
   parent directory (which should find the right version of Python).

 * Fix ``upload`` command not uploading files built by ``bdist_rpm`` or
   ``bdist_wininst`` under Python 2.3 and 2.4.

 * Add support for "eggsecutable" headers: a ``#!/bin/sh`` script that is
   prepended to an ``.egg`` file to allow it to be run as a script on Unix-ish
   platforms.  (This is mainly so that setuptools itself can have a single-file
   installer on Unix, without doing multiple downloads, dealing with firewalls,
   etc.)

 * Fix problem with empty revision numbers in Subversion 1.4 ``entries`` files

 * Use cross-platform relative paths in ``easy-install.pth`` when doing
   ``develop`` and the source directory is a subdirectory of the installation
   target directory.

 * Fix a problem installing eggs with a system packaging tool if the project
   contained an implicit namespace package; for example if the ``setup()``
   listed a namespace package ``foo.bar`` without explicitly listing ``foo``
   as a namespace package.

0.6c3
-----

 * Fixed breakages caused by Subversion 1.4's new "working copy" format

0.6c2
-----

 * The ``ez_setup`` module displays the conflicting version of setuptools (and
   its installation location) when a script requests a version that's not
   available.

 * Running ``setup.py develop`` on a setuptools-using project will now install
   setuptools if needed, instead of only downloading the egg.

0.6c1
-----

 * Fixed ``AttributeError`` when trying to download a ``setup_requires``
   dependency when a distribution lacks a ``dependency_links`` setting.

 * Made ``zip-safe`` and ``not-zip-safe`` flag files contain a single byte, so
   as to play better with packaging tools that complain about zero-length
   files.

 * Made ``setup.py develop`` respect the ``--no-deps`` option, which it
   previously was ignoring.

 * Support ``extra_path`` option to ``setup()`` when ``install`` is run in
   backward-compatibility mode.

 * Source distributions now always include a ``setup.cfg`` file that explicitly
   sets ``egg_info`` options such that they produce an identical version number
   to the source distribution's version number.  (Previously, the default
   version number could be different due to the use of ``--tag-date``, or if
   the version was overridden on the command line that built the source
   distribution.)

0.6b4
-----

 * Fix ``register`` not obeying name/version set by ``egg_info`` command, if
   ``egg_info`` wasn't explicitly run first on the same command line.

 * Added ``--no-date`` and ``--no-svn-revision`` options to ``egg_info``
   command, to allow suppressing tags configured in ``setup.cfg``.

 * Fixed redundant warnings about missing ``README`` file(s); it should now
   appear only if you are actually a source distribution.

0.6b3
-----

 * Fix ``bdist_egg`` not including files in subdirectories of ``.egg-info``.

 * Allow ``.py`` files found by the ``include_package_data`` option to be
   automatically included.  Remove duplicate data file matches if both
   ``include_package_data`` and ``package_data`` are used to refer to the same
   files.

0.6b1
-----

 * Strip ``module`` from the end of compiled extension modules when computing
   the name of a ``.py`` loader/wrapper.  (Python's import machinery ignores
   this suffix when searching for an extension module.)

0.6a11
------

 * Added ``test_loader`` keyword to support custom test loaders

 * Added ``setuptools.file_finders`` entry point group to allow implementing
   revision control plugins.

 * Added ``--identity`` option to ``upload`` command.

 * Added ``dependency_links`` to allow specifying URLs for ``--find-links``.

 * Enhanced test loader to scan packages as well as modules, and call
   ``additional_tests()`` if present to get non-unittest tests.

 * Support namespace packages in conjunction with system packagers, by omitting
   the installation of any ``__init__.py`` files for namespace packages, and
   adding a special ``.pth`` file to create a working package in
   ``sys.modules``.

 * Made ``--single-version-externally-managed`` automatic when ``--root`` is
   used, so that most system packagers won't require special support for
   setuptools.

 * Fixed ``setup_requires``, ``tests_require``, etc. not using ``setup.cfg`` or
   other configuration files for their option defaults when installing, and
   also made the install use ``--multi-version`` mode so that the project
   directory doesn't need to support .pth files.

 * ``MANIFEST.in`` is now forcibly closed when any errors occur while reading
   it.  Previously, the file could be left open and the actual error would be
   masked by problems trying to remove the open file on Windows systems.

0.6a10
------

 * Fixed the ``develop`` command ignoring ``--find-links``.

0.6a9
-----

 * The ``sdist`` command no longer uses the traditional ``MANIFEST`` file to
   create source distributions.  ``MANIFEST.in`` is still read and processed,
   as are the standard defaults and pruning.  But the manifest is built inside
   the project's ``.egg-info`` directory as ``SOURCES.txt``, and it is rebuilt
   every time the ``egg_info`` command is run.

 * Added the ``include_package_data`` keyword to ``setup()``, allowing you to
   automatically include any package data listed in revision control or
   ``MANIFEST.in``

 * Added the ``exclude_package_data`` keyword to ``setup()``, allowing you to
   trim back files included via the ``package_data`` and
   ``include_package_data`` options.

 * Fixed ``--tag-svn-revision`` not working when run from a source
   distribution.

 * Added warning for namespace packages with missing ``declare_namespace()``

 * Added ``tests_require`` keyword to ``setup()``, so that e.g. packages
   requiring ``nose`` to run unit tests can make this dependency optional
   unless the ``test`` command is run.

 * Made all commands that use ``easy_install`` respect its configuration
   options, as this was causing some problems with ``setup.py install``.

 * Added an ``unpack_directory()`` driver to ``setuptools.archive_util``, so
   that you can process a directory tree through a processing filter as if it
   were a zipfile or tarfile.

 * Added an internal ``install_egg_info`` command to use as part of old-style
   ``install`` operations, that installs an ``.egg-info`` directory with the
   package.

 * Added a ``--single-version-externally-managed`` option to the ``install``
   command so that you can more easily wrap a "flat" egg in a system package.

 * Enhanced ``bdist_rpm`` so that it installs single-version eggs that
   don't rely on a ``.pth`` file.  The ``--no-egg`` option has been removed,
   since all RPMs are now built in a more backwards-compatible format.

 * Support full roundtrip translation of eggs to and from ``bdist_wininst``
   format.  Running ``bdist_wininst`` on a setuptools-based package wraps the
   egg in an .exe that will safely install it as an egg (i.e., with metadata
   and entry-point wrapper scripts), and ``easy_install`` can turn the .exe
   back into an ``.egg`` file or directory and install it as such.


0.6a8
-----

 * Fixed some problems building extensions when Pyrex was installed, especially
   with Python 2.4 and/or packages using SWIG.

 * Made ``develop`` command accept all the same options as ``easy_install``,
   and use the ``easy_install`` command's configuration settings as defaults.

 * Made ``egg_info --tag-svn-revision`` fall back to extracting the revision
   number from ``PKG-INFO`` in case it is being run on a source distribution of
   a snapshot taken from a Subversion-based project.

 * Automatically detect ``.dll``, ``.so`` and ``.dylib`` files that are being
   installed as data, adding them to ``native_libs.txt`` automatically.

 * Fixed some problems with fresh checkouts of projects that don't include
   ``.egg-info/PKG-INFO`` under revision control and put the project's source
   code directly in the project directory.  If such a package had any
   requirements that get processed before the ``egg_info`` command can be run,
   the setup scripts would fail with a "Missing 'Version:' header and/or
   PKG-INFO file" error, because the egg runtime interpreted the unbuilt
   metadata in a directory on ``sys.path`` (i.e. the current directory) as
   being a corrupted egg.  Setuptools now monkeypatches the distribution
   metadata cache to pretend that the egg has valid version information, until
   it has a chance to make it actually be so (via the ``egg_info`` command).

0.6a5
-----

 * Fixed missing gui/cli .exe files in distribution.  Fixed bugs in tests.

0.6a3
-----

 * Added ``gui_scripts`` entry point group to allow installing GUI scripts
   on Windows and other platforms.  (The special handling is only for Windows;
   other platforms are treated the same as for ``console_scripts``.)

0.6a2
-----

 * Added ``console_scripts`` entry point group to allow installing scripts
   without the need to create separate script files.  On Windows, console
   scripts get an ``.exe`` wrapper so you can just type their name.  On other
   platforms, the scripts are written without a file extension.

0.6a1
-----

 * Added support for building "old-style" RPMs that don't install an egg for
   the target package, using a ``--no-egg`` option.

 * The ``build_ext`` command now works better when using the ``--inplace``
   option and multiple Python versions.  It now makes sure that all extensions
   match the current Python version, even if newer copies were built for a
   different Python version.

 * The ``upload`` command no longer attaches an extra ``.zip`` when uploading
   eggs, as PyPI now supports egg uploads without trickery.

 * The ``ez_setup`` script/module now displays a warning before downloading
   the setuptools egg, and attempts to check the downloaded egg against an
   internal MD5 checksum table.

 * Fixed the ``--tag-svn-revision`` option of ``egg_info`` not finding the
   latest revision number; it was using the revision number of the directory
   containing ``setup.py``, not the highest revision number in the project.

 * Added ``eager_resources`` setup argument

 * The ``sdist`` command now recognizes Subversion "deleted file" entries and
   does not include them in source distributions.

 * ``setuptools`` now embeds itself more thoroughly into the distutils, so that
   other distutils extensions (e.g. py2exe, py2app) will subclass setuptools'
   versions of things, rather than the native distutils ones.

 * Added ``entry_points`` and ``setup_requires`` arguments to ``setup()``;
   ``setup_requires`` allows you to automatically find and download packages
   that are needed in order to *build* your project (as opposed to running it).

 * ``setuptools`` now finds its commands, ``setup()`` argument validators, and
   metadata writers using entry points, so that they can be extended by
2479 2480 2481
   third-party packages.  See `Creating distutils Extensions
   <http://pythonhosted.org/setuptools/setuptools.html#creating-distutils-extensions>`_
   for more details.
2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681

 * The vestigial ``depends`` command has been removed.  It was never finished
   or documented, and never would have worked without EasyInstall - which it
   pre-dated and was never compatible with.

0.5a12
------

 * The zip-safety scanner now checks for modules that might be used with
   ``python -m``, and marks them as unsafe for zipping, since Python 2.4 can't
   handle ``-m`` on zipped modules.

0.5a11
------

 * Fix breakage of the "develop" command that was caused by the addition of
   ``--always-unzip`` to the ``easy_install`` command.

0.5a9
-----

 * Include ``svn:externals`` directories in source distributions as well as
   normal subversion-controlled files and directories.

 * Added ``exclude=patternlist`` option to ``setuptools.find_packages()``

 * Changed --tag-svn-revision to include an "r" in front of the revision number
   for better readability.

 * Added ability to build eggs without including source files (except for any
   scripts, of course), using the ``--exclude-source-files`` option to
   ``bdist_egg``.

 * ``setup.py install`` now automatically detects when an "unmanaged" package
   or module is going to be on ``sys.path`` ahead of a package being installed,
   thereby preventing the newer version from being imported.  If this occurs,
   a warning message is output to ``sys.stderr``, but installation proceeds
   anyway.  The warning message informs the user what files or directories
   need deleting, and advises them they can also use EasyInstall (with the
   ``--delete-conflicting`` option) to do it automatically.

 * The ``egg_info`` command now adds a ``top_level.txt`` file to the metadata
   directory that lists all top-level modules and packages in the distribution.
   This is used by the ``easy_install`` command to find possibly-conflicting
   "unmanaged" packages when installing the distribution.

 * Added ``zip_safe`` and ``namespace_packages`` arguments to ``setup()``.
   Added package analysis to determine zip-safety if the ``zip_safe`` flag
   is not given, and advise the author regarding what code might need changing.

 * Fixed the swapped ``-d`` and ``-b`` options of ``bdist_egg``.

0.5a8
-----

 * The "egg_info" command now always sets the distribution metadata to "safe"
   forms of the distribution name and version, so that distribution files will
   be generated with parseable names (i.e., ones that don't include '-' in the
   name or version).  Also, this means that if you use the various ``--tag``
   options of "egg_info", any distributions generated will use the tags in the
   version, not just egg distributions.

 * Added support for defining command aliases in distutils configuration files,
   under the "[aliases]" section.  To prevent recursion and to allow aliases to
   call the command of the same name, a given alias can be expanded only once
   per command-line invocation.  You can define new aliases with the "alias"
   command, either for the local, global, or per-user configuration.

 * Added "rotate" command to delete old distribution files, given a set of
   patterns to match and the number of files to keep.  (Keeps the most
   recently-modified distribution files matching each pattern.)

 * Added "saveopts" command that saves all command-line options for the current
   invocation to the local, global, or per-user configuration file.  Useful for
   setting defaults without having to hand-edit a configuration file.

 * Added a "setopt" command that sets a single option in a specified distutils
   configuration file.

0.5a7
-----

 * Added "upload" support for egg and source distributions, including a bug
   fix for "upload" and a temporary workaround for lack of .egg support in
   PyPI.

0.5a6
-----

 * Beefed up the "sdist" command so that if you don't have a MANIFEST.in, it
   will include all files under revision control (CVS or Subversion) in the
   current directory, and it will regenerate the list every time you create a
   source distribution, not just when you tell it to.  This should make the
   default "do what you mean" more often than the distutils' default behavior
   did, while still retaining the old behavior in the presence of MANIFEST.in.

 * Fixed the "develop" command always updating .pth files, even if you
   specified ``-n`` or ``--dry-run``.

 * Slightly changed the format of the generated version when you use
   ``--tag-build`` on the "egg_info" command, so that you can make tagged
   revisions compare *lower* than the version specified in setup.py (e.g. by
   using ``--tag-build=dev``).

0.5a5
-----

 * Added ``develop`` command to ``setuptools``-based packages.  This command
   installs an ``.egg-link`` pointing to the package's source directory, and
   script wrappers that ``execfile()`` the source versions of the package's
   scripts.  This lets you put your development checkout(s) on sys.path without
   having to actually install them.  (To uninstall the link, use
   use ``setup.py develop --uninstall``.)

 * Added ``egg_info`` command to ``setuptools``-based packages.  This command
   just creates or updates the "projectname.egg-info" directory, without
   building an egg.  (It's used by the ``bdist_egg``, ``test``, and ``develop``
   commands.)

 * Enhanced the ``test`` command so that it doesn't install the package, but
   instead builds any C extensions in-place, updates the ``.egg-info``
   metadata, adds the source directory to ``sys.path``, and runs the tests
   directly on the source.  This avoids an "unmanaged" installation of the
   package to ``site-packages`` or elsewhere.

 * Made ``easy_install`` a standard ``setuptools`` command, moving it from
   the ``easy_install`` module to ``setuptools.command.easy_install``.  Note
   that if you were importing or extending it, you must now change your imports
   accordingly.  ``easy_install.py`` is still installed as a script, but not as
   a module.

0.5a4
-----

 * Setup scripts using setuptools can now list their dependencies directly in
   the setup.py file, without having to manually create a ``depends.txt`` file.
   The ``install_requires`` and ``extras_require`` arguments to ``setup()``
   are used to create a dependencies file automatically.  If you are manually
   creating ``depends.txt`` right now, please switch to using these setup
   arguments as soon as practical, because ``depends.txt`` support will be
   removed in the 0.6 release cycle.  For documentation on the new arguments,
   see the ``setuptools.dist.Distribution`` class.

 * Setup scripts using setuptools now always install using ``easy_install``
   internally, for ease of uninstallation and upgrading.

0.5a1
-----

 * Added support for "self-installation" bootstrapping.  Packages can now
   include ``ez_setup.py`` in their source distribution, and add the following
   to their ``setup.py``, in order to automatically bootstrap installation of
   setuptools as part of their setup process::

    from ez_setup import use_setuptools
    use_setuptools()

    from setuptools import setup
    # etc...

0.4a2
-----

 * Added ``ez_setup.py`` installer/bootstrap script to make initial setuptools
   installation easier, and to allow distributions using setuptools to avoid
   having to include setuptools in their source distribution.

 * All downloads are now managed by the ``PackageIndex`` class (which is now
   subclassable and replaceable), so that embedders can more easily override
   download logic, give download progress reports, etc.  The class has also
   been moved to the new ``setuptools.package_index`` module.

 * The ``Installer`` class no longer handles downloading, manages a temporary
   directory, or tracks the ``zip_ok`` option.  Downloading is now handled
   by ``PackageIndex``, and ``Installer`` has become an ``easy_install``
   command class based on ``setuptools.Command``.

 * There is a new ``setuptools.sandbox.run_setup()`` API to invoke a setup
   script in a directory sandbox, and a new ``setuptools.archive_util`` module
   with an ``unpack_archive()`` API.  These were split out of EasyInstall to
   allow reuse by other tools and applications.

 * ``setuptools.Command`` now supports reinitializing commands using keyword
   arguments to set/reset options.  Also, ``Command`` subclasses can now set
   their ``command_consumes_arguments`` attribute to ``True`` in order to
   receive an ``args`` option containing the rest of the command line.

0.3a2
-----

 * Added new options to ``bdist_egg`` to allow tagging the egg's version number
   with a subversion revision number, the current date, or an explicit tag
   value.  Run ``setup.py bdist_egg --help`` to get more information.

 * Misc. bug fixes

0.3a1
-----

 * Initial release.
2682