PKG-INFO 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. Metadata-Version: 1.1
  2. Name: setuptools
  3. Version: 24.0.2
  4. Summary: Easily download, build, install, upgrade, and uninstall Python packages
  5. Home-page: https://github.com/pypa/setuptools
  6. Author: Python Packaging Authority
  7. Author-email: distutils-sig@python.org
  8. License: UNKNOWN
  9. Description: ===============================
  10. Installing and Using Setuptools
  11. ===============================
  12. .. contents:: **Table of Contents**
  13. .. image:: https://setuptools.readthedocs.io/en/latest/?badge=latest
  14. :target: https://setuptools.readthedocs.io
  15. -------------------------
  16. Installation Instructions
  17. -------------------------
  18. The recommended way to bootstrap setuptools on any system is to download
  19. `ez_setup.py`_ and run it using the target Python environment. Different
  20. operating systems have different recommended techniques to accomplish this
  21. basic routine, so below are some examples to get you started.
  22. Setuptools requires Python 2.6 or later. To install setuptools
  23. on Python 2.4 or Python 2.5, use the `bootstrap script for Setuptools 1.x
  24. <https://raw.githubusercontent.com/pypa/setuptools/bootstrap-py24/ez_setup.py>`_.
  25. The link provided to ez_setup.py is a bookmark to bootstrap script for the
  26. latest known stable release.
  27. .. _ez_setup.py: https://bootstrap.pypa.io/ez_setup.py
  28. Windows (Powershell 3 or later)
  29. ===============================
  30. For best results, uninstall previous versions FIRST (see `Uninstalling`_).
  31. Using Windows 8 (which includes PowerShell 3) or earlier versions of Windows
  32. with PowerShell 3 installed, it's possible to install with one simple
  33. Powershell command. Start up Powershell and paste this command::
  34. > (Invoke-WebRequest https://bootstrap.pypa.io/ez_setup.py).Content | python -
  35. .. image:: https://badges.gitter.im/pypa/setuptools.svg
  36. :alt: Join the chat at https://gitter.im/pypa/setuptools
  37. :target: https://gitter.im/pypa/setuptools?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
  38. You must start the Powershell with Administrative privileges or you may choose
  39. to install a user-local installation::
  40. > (Invoke-WebRequest https://bootstrap.pypa.io/ez_setup.py).Content | python - --user
  41. If you have Python 3.3 or later, you can use the ``py`` command to install to
  42. different Python versions. For example, to install to Python 3.3 if you have
  43. Python 2.7 installed::
  44. > (Invoke-WebRequest https://bootstrap.pypa.io/ez_setup.py).Content | py -3 -
  45. The recommended way to install setuptools on Windows is to download
  46. `ez_setup.py`_ and run it. The script will download the appropriate
  47. distribution file and install it for you.
  48. Once installation is complete, you will find an ``easy_install`` program in
  49. your Python ``Scripts`` subdirectory. For simple invocation and best results,
  50. add this directory to your ``PATH`` environment variable, if it is not already
  51. present. If you did a user-local install, the ``Scripts`` subdirectory is
  52. ``$env:APPDATA\Python\Scripts``.
  53. Windows (simplified)
  54. ====================
  55. For Windows without PowerShell 3 or for installation without a command-line,
  56. download `ez_setup.py`_ using your preferred web browser or other technique
  57. and "run" that file.
  58. Unix (wget)
  59. ===========
  60. Most Linux distributions come with wget.
  61. Download `ez_setup.py`_ and run it using the target Python version. The script
  62. will download the appropriate version and install it for you::
  63. > wget https://bootstrap.pypa.io/ez_setup.py -O - | python
  64. Note that you will may need to invoke the command with superuser privileges to
  65. install to the system Python::
  66. > wget https://bootstrap.pypa.io/ez_setup.py -O - | sudo python
  67. Alternatively, Setuptools may be installed to a user-local path::
  68. > wget https://bootstrap.pypa.io/ez_setup.py -O - | python - --user
  69. Note that on some older systems (noted on Debian 6 and CentOS 5 installations),
  70. `wget` may refuse to download `ez_setup.py`, complaining that the certificate common name `*.c.ssl.fastly.net`
  71. does not match the host name `bootstrap.pypa.io`. In addition, the `ez_setup.py` script may then encounter similar problems using
  72. `wget` internally to download `setuptools-x.y.zip`, complaining that the certificate common name of `www.python.org` does not match the
  73. host name `pypi.python.org`. Those are known issues, related to a bug in the older versions of `wget`
  74. (see `Issue 59 <https://bitbucket.org/pypa/pypi/issue/59#comment-5881915>`_). If you happen to encounter them,
  75. install Setuptools as follows::
  76. > wget --no-check-certificate https://bootstrap.pypa.io/ez_setup.py
  77. > python ez_setup.py --insecure
  78. Unix including Mac OS X (curl)
  79. ==============================
  80. If your system has curl installed, follow the ``wget`` instructions but
  81. replace ``wget`` with ``curl`` and ``-O`` with ``-o``. For example::
  82. > curl https://bootstrap.pypa.io/ez_setup.py -o - | python
  83. Advanced Installation
  84. =====================
  85. For more advanced installation options, such as installing to custom
  86. locations or prefixes, download and extract the source
  87. tarball from `Setuptools on PyPI <https://pypi.python.org/pypi/setuptools>`_
  88. and run setup.py with any supported distutils and Setuptools options.
  89. For example::
  90. setuptools-x.x$ python setup.py install --prefix=/opt/setuptools
  91. Use ``--help`` to get a full options list, but we recommend consulting
  92. the `EasyInstall manual`_ for detailed instructions, especially `the section
  93. on custom installation locations`_.
  94. .. _EasyInstall manual: https://pythonhosted.org/setuptools/EasyInstall
  95. .. _the section on custom installation locations: https://pythonhosted.org/setuptools/EasyInstall#custom-installation-locations
  96. Downloads
  97. =========
  98. All setuptools downloads can be found at `the project's home page in the Python
  99. Package Index`_. Scroll to the very bottom of the page to find the links.
  100. .. _the project's home page in the Python Package Index: https://pypi.python.org/pypi/setuptools
  101. In addition to the PyPI downloads, the development version of ``setuptools``
  102. is available from the `Bitbucket repo`_, and in-development versions of the
  103. `0.6 branch`_ are available as well.
  104. .. _Bitbucket repo: https://bitbucket.org/pypa/setuptools/get/default.tar.gz#egg=setuptools-dev
  105. .. _0.6 branch: http://svn.python.org/projects/sandbox/branches/setuptools-0.6/#egg=setuptools-dev06
  106. Uninstalling
  107. ============
  108. On Windows, if Setuptools was installed using an ``.exe`` or ``.msi``
  109. installer, simply use the uninstall feature of "Add/Remove Programs" in the
  110. Control Panel.
  111. Otherwise, to uninstall Setuptools or Distribute, regardless of the Python
  112. version, delete all ``setuptools*`` and ``distribute*`` files and
  113. directories from your system's ``site-packages`` directory
  114. (and any other ``sys.path`` directories) FIRST.
  115. If you are upgrading or otherwise plan to re-install Setuptools or Distribute,
  116. nothing further needs to be done. If you want to completely remove Setuptools,
  117. you may also want to remove the 'easy_install' and 'easy_install-x.x' scripts
  118. and associated executables installed to the Python scripts directory.
  119. --------------------------------
  120. Using Setuptools and EasyInstall
  121. --------------------------------
  122. Here are some of the available manuals, tutorials, and other resources for
  123. learning about Setuptools, Python Eggs, and EasyInstall:
  124. * `The EasyInstall user's guide and reference manual`_
  125. * `The setuptools Developer's Guide`_
  126. * `The pkg_resources API reference`_
  127. * `The Internal Structure of Python Eggs`_
  128. Questions, comments, and bug reports should be directed to the `distutils-sig
  129. mailing list`_. If you have written (or know of) any tutorials, documentation,
  130. plug-ins, or other resources for setuptools users, please let us know about
  131. them there, so this reference list can be updated. If you have working,
  132. *tested* patches to correct problems or add features, you may submit them to
  133. the `setuptools bug tracker`_.
  134. .. _setuptools bug tracker: https://github.com/pypa/setuptools/issues
  135. .. _The Internal Structure of Python Eggs: https://setuptools.readthedocs.io/en/latest/formats.html
  136. .. _The setuptools Developer's Guide: https://setuptools.readthedocs.io/en/latest/developer-guide.html
  137. .. _The pkg_resources API reference: https://setuptools.readthedocs.io/en/latest/pkg_resources.html
  138. .. _The EasyInstall user's guide and reference manual: https://setuptools.readthedocs.io/en/latest/easy_install.html
  139. .. _distutils-sig mailing list: http://mail.python.org/pipermail/distutils-sig/
  140. -------
  141. Credits
  142. -------
  143. * The original design for the ``.egg`` format and the ``pkg_resources`` API was
  144. co-created by Phillip Eby and Bob Ippolito. Bob also implemented the first
  145. version of ``pkg_resources``, and supplied the OS X operating system version
  146. compatibility algorithm.
  147. * Ian Bicking implemented many early "creature comfort" features of
  148. easy_install, including support for downloading via Sourceforge and
  149. Subversion repositories. Ian's comments on the Web-SIG about WSGI
  150. application deployment also inspired the concept of "entry points" in eggs,
  151. and he has given talks at PyCon and elsewhere to inform and educate the
  152. community about eggs and setuptools.
  153. * Jim Fulton contributed time and effort to build automated tests of various
  154. aspects of ``easy_install``, and supplied the doctests for the command-line
  155. ``.exe`` wrappers on Windows.
  156. * Phillip J. Eby is the seminal author of setuptools, and
  157. first proposed the idea of an importable binary distribution format for
  158. Python application plug-ins.
  159. * Significant parts of the implementation of setuptools were funded by the Open
  160. Source Applications Foundation, to provide a plug-in infrastructure for the
  161. Chandler PIM application. In addition, many OSAF staffers (such as Mike
  162. "Code Bear" Taylor) contributed their time and stress as guinea pigs for the
  163. use of eggs and setuptools, even before eggs were "cool". (Thanks, guys!)
  164. * Tarek Ziadé is the principal author of the Distribute fork, which
  165. re-invigorated the community on the project, encouraged renewed innovation,
  166. and addressed many defects.
  167. * Since the merge with Distribute, Jason R. Coombs is the
  168. maintainer of setuptools. The project is maintained in coordination with
  169. the Python Packaging Authority (PyPA) and the larger Python community.
  170. .. _files:
  171. ---------------
  172. Code of Conduct
  173. ---------------
  174. Everyone interacting in the setuptools project's codebases, issue trackers,
  175. chat rooms, and mailing lists is expected to follow the
  176. `PyPA Code of Conduct`_.
  177. .. _PyPA Code of Conduct: https://www.pypa.io/en/latest/code-of-conduct/
  178. Keywords: CPAN PyPI distutils eggs package management
  179. Platform: UNKNOWN
  180. Classifier: Development Status :: 5 - Production/Stable
  181. Classifier: Intended Audience :: Developers
  182. Classifier: License :: OSI Approved :: MIT License
  183. Classifier: Operating System :: OS Independent
  184. Classifier: Programming Language :: Python :: 2.6
  185. Classifier: Programming Language :: Python :: 2.7
  186. Classifier: Programming Language :: Python :: 3
  187. Classifier: Programming Language :: Python :: 3.3
  188. Classifier: Programming Language :: Python :: 3.4
  189. Classifier: Programming Language :: Python :: 3.5
  190. Classifier: Topic :: Software Development :: Libraries :: Python Modules
  191. Classifier: Topic :: System :: Archiving :: Packaging
  192. Classifier: Topic :: System :: Systems Administration
  193. Classifier: Topic :: Utilities