[tor-commits] [stem/master] Stem release 1.5.2

[atagar at torproject.org]

commit bf34c2bf5fdb6eea84d9589225783ec5b16e8278
Author: Damian Johnson <atagar at torproject.org>
Date:   Thu Nov 17 10:06:01 2016 -0800

    Stem release 1.5.2
    
    Release creation in PyPI is both error prone and unfixable. As such it's safest
    if we have a scrap project to sanity check that things are working as intended
    before permanently screwing up our package. Really silly we need to do this,
    but that's life.
    
      https://github.com/pypa/packaging-problems/issues/74#issuecomment-260716129
    
    Previously we made releases with 'python setup.py upload' but PyPI has broken
    this by prohibiting non-SSL uploads. Twine now seems to be the only game in
    town so updating our setup.py clauses with things we previously set via the
    site. One caveat is that PyPI's bug tracker field evidently cannot be set
    via the setup.py...
    
      https://stackoverflow.com/questions/14459828/how-to-set-bug-tracker-url-in-setup-py-script
    
    Oh well. Close enough.
---
 docs/index.rst   |  2 +-
 setup.py         | 37 +++++++++++++++++++++++++++++++++++--
 stem/__init__.py |  2 +-
 3 files changed, 37 insertions(+), 4 deletions(-)

diff --git a/docs/index.rst b/docs/index.rst
index eb58df2..da9362b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,7 +1,7 @@
 Welcome to Stem!
 ================
 
-Stem is a Python controller library for `Tor <https://www.torproject.org/>`_. With it you can use Tor's `control protocol <https://gitweb.torproject.org/torspec.git/tree/control-spec.txt>`_ to script against the Tor process, or build things such as `arm <https://www.atagar.com/arm/>`_. Stem's latest version is **1.5.1** (released November 15th, 2016).
+Stem is a Python controller library for `Tor <https://www.torproject.org/>`_. With it you can use Tor's `control protocol <https://gitweb.torproject.org/torspec.git/tree/control-spec.txt>`_ to script against the Tor process, or build things such as `arm <https://www.atagar.com/arm/>`_. Stem's latest version is **1.5.2** (released November 20th, 2016).
 
 .. Main Stem Logo
    Source: http://www.wpclipart.com/plants/assorted/P/plant_stem.png.html
diff --git a/setup.py b/setup.py
index 2e492d4..7d7e5e9 100644
--- a/setup.py
+++ b/setup.py
@@ -5,11 +5,36 @@
 import distutils.core
 import stem
 
+DRY_RUN = True
+SUMMARY = 'Stem is a Python controller library that allows applications to interact with Tor (https://www.torproject.org/).'
+DRY_RUN_SUMMARY = "Ignore this package. This is dry-run release creation to work around PyPI limitations (https://github.com/pypa/packaging-problems/issues/74#issuecomment-260716129)."
+
+DESCRIPTION = """
+For tutorials and API documentation see `stem's homepage <https://stem.torproject.org/>`_.
+
+Quick Start
+-----------
+
+To install you can either use...
+
+::
+
+  pip install stem
+        
+... or install from the source tarball. Stem supports both the python 2.x and 3.x series. To use its python3 counterpart you simply need to install using that version of python.
+
+::
+
+  python3 setup.py install
+
+After that, give some `tutorials <https://stem.torproject.org/tutorials.html>`_ a try! For questions or to discuss project ideas we're available on `irc <https://www.torproject.org/about/contact.html.en#irc>`_ and the `tor-dev@ email list <https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-dev>`_.
+""".strip()
 
 distutils.core.setup(
-  name = 'stem',
+  name = 'stem-dry-run' if DRY_RUN else 'stem',
   version = stem.__version__,
-  description = 'Controller library for interacting with Tor <https://www.torproject.org/>',
+  description = DRY_RUN_SUMMARY if DRY_RUN else SUMMARY,
+  long_description = DESCRIPTION,
   license = stem.__license__,
   author = stem.__author__,
   author_email = stem.__contact__,
@@ -18,4 +43,12 @@ distutils.core.setup(
   keywords = 'tor onion controller',
   scripts = ['tor-prompt'],
   package_data = {'stem': ['cached_tor_manual.cfg', 'settings.cfg'], 'stem.descriptor': ['fallback_directories.cfg'], 'stem.interpreter': ['settings.cfg'], 'stem.util': ['ports.cfg']},
+  provides = ['stem'],
+  classifiers = [
+    'Development Status :: 5 - Production/Stable',
+    'Intended Audience :: Developers',
+    'License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)',
+    'Topic :: Security',
+    'Topic :: Software Development :: Libraries :: Python Modules',
+  ],
 )
diff --git a/stem/__init__.py b/stem/__init__.py
index 47b9a8f..7cf39f2 100644
--- a/stem/__init__.py
+++ b/stem/__init__.py
@@ -470,7 +470,7 @@ Library for working with the tor process.
 
 import stem.util.enum
 
-__version__ = '1.5.1'
+__version__ = '1.5.2'
 __author__ = 'Damian Johnson'
 __contact__ = 'atagar at torproject.org'
 __url__ = 'https://stem.torproject.org/'