[tor-commits] [nyx/master] Dry-run packaging and update installation attributes

[atagar at torproject.org]

commit 590a245efbb6fd6ac0ba149daf3d0d7ac283949b
Author: Damian Johnson <atagar at torproject.org>
Date:   Sun Nov 5 13:12:21 2017 -0800

    Dry-run packaging and update installation attributes
    
    Modeling our packaging after Stem, with support for release dry-runs.
---
 nyx/__init__.py |  6 +++---
 setup.py        | 39 ++++++++++++++++++++++++++++++++++++---
 2 files changed, 39 insertions(+), 6 deletions(-)

diff --git a/nyx/__init__.py b/nyx/__init__.py
index 5a8de5d..4133c1d 100644
--- a/nyx/__init__.py
+++ b/nyx/__init__.py
@@ -89,11 +89,11 @@ except ImportError:
 
   sys.exit(1)
 
-__version__ = '1.4.6-dev'
-__release_date__ = 'April 28, 2011'
+__version__ = '2.0.0'
+__release_date__ = 'November 5, 2017'
 __author__ = 'Damian Johnson'
 __contact__ = 'atagar at torproject.org'
-__url__ = 'http://www.atagar.com/arm/'
+__url__ = 'https://nyx.torproject.org/'
 __license__ = 'GPLv3'
 
 __all__ = [
diff --git a/setup.py b/setup.py
index d463c2a..5a24ca2 100644
--- a/setup.py
+++ b/setup.py
@@ -5,6 +5,7 @@
 import gzip
 import os
 import stat
+import sys
 import sysconfig
 
 import nyx
@@ -14,6 +15,30 @@ from distutils.core import setup
 from distutils.command.install import install
 
 
+if '--dryrun' in sys.argv:
+  DRY_RUN = True
+  sys.argv.remove('--dryrun')
+else:
+  DRY_RUN = False
+
+SUMMARY = 'Terminal status monitor for 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 = """
+Nyx is a command-line monitor for Tor. With this you can get detailed real-time information about your relay such as bandwidth usage, connections, logs, and much more. For more information see `Nyx's homepage <https://nyx.torproject.org/>`_
+
+Quick Start
+-----------
+
+To install you can either use...
+
+::
+
+  pip install nyx
+
+... or install from the source tarball. Nyx supports both the python 2.x and 3.x series.
+"""
+
 class NyxInstaller(install):
   """
   Nyx installer. This adds the following additional options...
@@ -92,16 +117,24 @@ setup_dir = os.path.dirname(os.path.join(os.getcwd(), __file__))
 os.chdir(setup_dir)
 
 setup(
-  name = 'nyx',
+  name = 'nyx-dry-run' if DRY_RUN else 'nyx',
   version = nyx.__version__,
-  description = 'Terminal status monitor for Tor <https://www.torproject.org/>',
+  description = DRY_RUN_SUMMARY if DRY_RUN else SUMMARY,
+  long_description = DESCRIPTION,
   license = nyx.__license__,
   author = nyx.__author__,
   author_email = nyx.__contact__,
   url = nyx.__url__,
   packages = ['nyx', 'nyx.panel'],
   keywords = 'tor onion controller',
-  install_requires = ['stem>=1.4.1'],
+  install_requires = ['stem>=1.6.0'],
   package_data = {'nyx': ['settings/*']},
   cmdclass = {'install': NyxInstaller},
+  classifiers = [
+    'Development Status :: 5 - Production/Stable',
+    'Environment :: Console :: Curses',
+    'Intended Audience :: System Administrators',
+    'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
+    'Topic :: Security',
+  ],
 )