Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README and supported python versions to PyPI description #258

Merged
merged 3 commits into from
May 20, 2016
Merged

Add README and supported python versions to PyPI description #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d2f6409
Fix #256. Add README to PyPI description and add supported python ve…
johnthagen May 17, 2016
8b6ccd6
Fix operating system classifier to properly denote only Unix, Linux, …
johnthagen May 19, 2016
3091b2b
Have header style match README.rst.
johnthagen May 20, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 2 additions & 43 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
=======
CHANGES
=======
Release Notes
=============

-----
1.1.6
-----

Expand All @@ -16,7 +14,6 @@ This release is a quick fix for a regression that inadvertently went out in 1.1.
`#244 <https://github.com/pantsbuild/pex/pull/244>`_
`Fixes #238 <https://github.com/pantsbuild/pex/issues/238>`_

-----
1.1.5
-----

Expand All @@ -35,7 +32,6 @@ This release is a quick fix for a regression that inadvertently went out in 1.1.
`#221 <https://github.com/pantsbuild/pex/issues/221>`_
`Fixes #220 <https://github.com/pantsbuild/pex/issues/220>`_

-----
1.1.4
-----

Expand All @@ -44,7 +40,6 @@ This release is a quick fix for a regression that inadvertently went out in 1.1.
* Add a test for the regression in ``FixedEggMetadata._zipinfo_name`` and revert the breaking commit.
`Fixes #216 <https://github.com/pantsbuild/pex/issues/216>`_

-----
1.1.3
-----

Expand All @@ -66,7 +61,6 @@ This release includes an initial body of work towards Windows support, ABI tag s
* Fixes to get pex to work on windows.
`#198 <https://github.com/pantsbuild/pex/pull/198>`_

-----
1.1.2
-----

Expand All @@ -79,7 +73,6 @@ This release includes an initial body of work towards Windows support, ABI tag s
* Memoize calls to Crawler.crawl() for performance win in find-links based resolution.
`#187 <https://github.com/pantsbuild/pex/pull/187>`_

-----
1.1.1
-----

Expand All @@ -92,7 +85,6 @@ This release includes an initial body of work towards Windows support, ABI tag s
* Improve error messaging for platform constrained Untranslateable errors.
`#179 <https://github.com/pantsbuild/pex/pull/179>`_

-----
1.1.0
-----

Expand All @@ -112,7 +104,6 @@ This release includes an initial body of work towards Windows support, ABI tag s

* Adds a pex-identifying User-Agent. `#101 <https://github.com/pantsbuild/pex/issues/101>`_.

-----
1.0.3
-----

Expand All @@ -127,7 +118,6 @@ This release includes an initial body of work towards Windows support, ABI tag s
* Bug fix: ``sys.exit`` called without arguments would cause `None` to be printed on stderr since pex 1.0.1.
`#143 <https://github.com/pantsbuild/pex/pull/143>`_.

-----
1.0.2
-----

Expand All @@ -143,7 +133,6 @@ This release includes an initial body of work towards Windows support, ABI tag s
teardown hooks behave more predictably.
Fixes `#141 <https://github.com/pantsbuild/pex/issues/141>`_.

-----
1.0.1
-----

Expand All @@ -157,7 +146,6 @@ This release includes an initial body of work towards Windows support, ABI tag s
* Bug fix: Fix complex resolutions when using a cache.
Fixes: `#120 <https://github.com/pantsbuild/pex/issues/120>`_.

-----
1.0.0
-----

Expand Down Expand Up @@ -224,7 +212,6 @@ For users of the PEX CLI, major version ranges such as ``pex>=1,<2`` should be s
* Bug fix: Fixes caching in the PEX tool since we don't cache the source distributions of installable
directories. `#24 <https://github.com/pantsbuild/pex/issues/24>`_.

-----
0.9.0
-----

Expand All @@ -246,7 +233,6 @@ This is the last release before the 1.0.0 development branch is started.
Implements `#47 <https://github.com/pantsbuild/pex/issues/47>`_ in order to
fix `#48 <https://github.com/pantsbuild/pex/issues/48>`_

-----
0.8.6
-----

Expand All @@ -256,14 +242,12 @@ This is the last release before the 1.0.0 development branch is started.
* Bug fix: ``UrllibContext`` used ``replace`` as a keyword argument for ``bytes.decode``
but this only works on Python 3. `Pull Request #46 <https://github.com/pantsbuild/pex/pull/46>`_

-----
0.8.5
-----

* Bug fix: Fixup string formatting in pex/bin/pex.py to support Python 2.6
`Pull Request #40 <https://github.com/pantsbuild/pex/pull/40>`_

-----
0.8.4
-----

Expand All @@ -282,7 +266,6 @@ This is the last release before the 1.0.0 development branch is started.
compatibility.
`Pull Request #33 <https://github.com/pantsbuild/pex/pull/33>`_

-----
0.8.3
-----

Expand All @@ -291,7 +274,6 @@ This is the last release before the 1.0.0 development branch is started.
number of non-zip-safe dependencies.
`RB #1642 <https://rbcommons.com/s/twitter/r/1642>`_

-----
0.8.2
-----

Expand All @@ -301,14 +283,12 @@ This is the last release before the 1.0.0 development branch is started.
* Pin pex to setuptools prior to 9.x until we have a chance to make changes
related to PEP440 and the change of pkg_resources.py to a package.

-----
0.8.1
-----

* Bug fix: Fix issue where it'd be possible to ``os.path.getmtime`` on a remote ``Link`` object
`Issue #29 <https://github.com/pantsbuild/pex/issues/29>`_

-----
0.8.0
-----

Expand Down Expand Up @@ -357,21 +337,18 @@ This is the last release before the 1.0.0 development branch is started.
an encoding issue only experienced when using Python 3.
`Issue #10 <https://github.com/pantsbuild/pex/issues/10>`_

-----
0.7.0
-----

* Rename ``twitter.common.python`` to ``pex`` and split out from the
`twitter/commons <http://github.com/twitter/commons>`_ repo.

-----
0.6.0
-----

* Change the interpretation of ``-i`` (and of PyPIFetcher's pypi_base)
to match pip's ``-i``. This is useful for compatibility with devpi.

------
0.5.10
------

Expand All @@ -383,7 +360,6 @@ This is the last release before the 1.0.0 development branch is started.
never be used again, and builds would re-create the same distributions
in tmpdirs over and over again.

-----
0.5.9
-----

Expand All @@ -396,13 +372,11 @@ This is the last release before the 1.0.0 development branch is started.
changed a runtime error would be thrown due to seemingly corrupt zip file
offsets. `RB #684 <https://rbcommons.com/s/twitter/r/684/>`_

-----
0.5.8
-----

* Adds ``-i/--index`` option to the pex tool.

-----
0.5.7
-----

Expand All @@ -413,22 +387,19 @@ This is the last release before the 1.0.0 development branch is started.
* Adds stdin=,stdout=,stderr= keyword parameters to the ``PEX.run`` function.
(Patch from @benjy)

-----
0.5.6
-----

* The crawler now defaults to not follow links for security reasons.
(Before the default behavior was to implicitly ``--follow-links`` for all
requirements.) `RB #293 <https://rbcommons.com/s/twitter/r/293/>`_

-----
0.5.5
-----

* Improves scrubbing of site-packages from PEX environments.
`RB #289 <https://rbcommons.com/s/twitter/r/289/>`_

-------------
0.5.1 - 0.5.4
-------------

Expand All @@ -440,7 +411,6 @@ This is the last release before the 1.0.0 development branch is started.
* Adds ``__hash__`` to ``Link`` so that Packages are hashed correctly in
``twitter.common.python.resolver`` ``resolve``

-----
0.5.0
-----

Expand All @@ -449,7 +419,6 @@ This is the last release before the 1.0.0 development branch is started.
`RB #154 <https://rbcommons.com/s/twitter/r/154/>`_
`RB #148 <https://rbcommons.com/s/twitter/r/148/>`_

-----
0.4.3
-----

Expand Down Expand Up @@ -489,26 +458,22 @@ This is the last release before the 1.0.0 development branch is started.
* Bug fix: Raise a ``RuntimeError`` if we fail to write ``pkg_resources`` into a .pex
`RB #115 <https://rbcommons.com/s/twitter/r/115/>`_

-----
0.4.2
-----

* Upgrade to ``setuptools>=1``

-----
0.4.1
-----

* ``twitter.common.python`` is no longer a namespace package

-----
0.4.0
-----

* Kill the egg distiller. We now delegate .egg generation to bdist_egg.
`RB #55 <https://rbcommons.com/s/twitter/r/55/>`_

-----
0.3.1
-----

Expand All @@ -522,7 +487,6 @@ This is the last release before the 1.0.0 development branch is started.
`Setuptools Issue #154 <https://bitbucket.org/pypa/setuptools/issue/154/build_zipmanifest-results-should-be>`_
`RB #53 <https://rbcommons.com/s/twitter/r/53/>`_

-----
0.3.0
-----

Expand Down Expand Up @@ -565,33 +529,28 @@ This is the last release before the 1.0.0 development branch is started.
* Bug fix: Handle setuptools>=2.1 correctly in the zipimport monkeypatch
(Patch from @johnsirois.)

-----
0.2.3
-----

* Bug fix: Fix handling of Fetchers with ``file://`` urls.

-----
0.2.2
-----

* Adds the pex tool as a standalone tool.

-----
0.2.1
-----

* Bug fix: Bootstrapped ``twitter.common.python`` should declare ``twitter.common``
as a namespace package.

-----
0.2.0
-----

* Make ``twitter.common.python`` fully standalone by consolidating
external dependencies within ``twitter.common.python.common``.

-----
0.1.0
-----

Expand Down
15 changes: 13 additions & 2 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@

from setuptools import setup

with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as fp:
LONG_DESCRIPTION = fp.read() + '\n'
Copy link
Contributor

@kwlzn kwlzn May 20, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here's a preview of what this concatenation would look like: https://gist.github.com/kwlzn/97f740834edcc03b6e729a3b18d641dc

note the disjoint styling between the concatenation. seems to me that we'd probably want to change the style of the CHANGES.rst header, which is currently:

=======
CHANGES
=======

to something like:

Release Notes
===========

to make this blend nicely.


with open(os.path.join(os.path.dirname(__file__), 'CHANGES.rst')) as fp:
LONG_DESCRIPTION = fp.read()
LONG_DESCRIPTION += fp.read()


# This seems to be a fairly standard version file pattern.
Expand All @@ -33,8 +35,17 @@
classifiers = [
'Intended Audience :: Developers',
'License :: OSI Approved :: Apache Software License',
'Operating System :: OS Independent',
'Operating System :: Unix',
'Operating System :: POSIX :: Linux',
'Operating System :: MacOS :: MacOS X',
'Programming Language :: Python',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
],
packages = [
'pex',
Expand Down