Merge pull request #20 from iheartradio/packaging

Release-readiness cleanup

AUTHORS.rst

@@ -0,0 +1,9 @@
+=======
+Authors
+=======
+
+The following folks have contributed to making this library possible.
+
+* Andy Dirnberger (`@dirn <https://github.com/dirn>`_)
+* Jon Banafato (`@jonafato <https://github.com/jonafato>`_)
+* Leonard Bedner (`@lbedner <https://github.com/lbedner>`_)

MANIFEST.in

@@ -0,0 +1,12 @@
+include AUTHORS.rst
+include LICENSE
+include README.rst
+
+recursive-include docs Makefile *.py *.rst
+
+exclude .coveragerc
+exclude .travis.yml
+exclude tox.ini
+
+prune docs/_build
+prune tests

README.rst

@@ -1,5 +1,13 @@
-##############
-Henson-Logging
-##############
+#############################
+Henson-Logging |build status|
+#############################
+
+.. |build status| image:: https://travis-ci.org/iheartradio/Henson-Logging.svg?branch=master
+   :target: https://travis-ci.org/iheartradio/Henso-Logging
 
 A library to use structured logging with a Henson application.
+
+* `Documentation <https://henson-logging.rtfd.org>`_
+* `Installation <https://henson-logging.readthedocs.org/en/latest/#installation>`_
+* `Changelog <https://henson-logging.readthedocs.org/en/latest/changes.html>`_
+* `Source <https://github.com/iheartradio/Henson-logging>`_

henson_logging/__init__.py

@@ -1,16 +1,27 @@
 """Logging plugin for Henson."""
 
-from pkg_resources import get_distribution
 import logging
 import logging.config
+import os
+import pkg_resources
 
 from henson import Extension
 import structlog
 
 from . import processors
 
 __all__ = ('Logging',)
-__version__ = get_distribution(__package__).version
+
+try:
+    _dist = pkg_resources.get_distribution(__package__)
+    if not __file__.startswith(os.path.join(_dist.location, __package__)):
+        # Manually raise the exception if there is a distribution but
+        # it's installed from elsewhere.
+        raise pkg_resources.DistributionNotFound
+except pkg_resources.DistributionNotFound:
+    __version__ = 'development'
+else:
+    __version__ = _dist.version
 
 
 class Logging(Extension):

setup.py

@@ -1,16 +1,45 @@
 from setuptools import find_packages, setup
+from setuptools.command.test import test as TestCommand
+import sys
+
+
+class PyTest(TestCommand):
+    def finalize_options(self):
+        super().finalize_options()
+        self.test_args = []
+        self.test_suite = True
+
+    def run_tests(self):
+        import pytest
+        sys.exit(pytest.main(self.test_args))
+
+
+def read(filename):
+    with open(filename) as f:
+        return f.read()
+
 
 setup(
     name='Henson-Logging',
     version='0.3.0',
+    author='Andy Dirnberger, Jon Banafato, and others',
+    author_email='[email protected]',
+    url='https://henson-logging.rtfd.org',
+    description='A library to use structured logging with a Henson application.',
+    long_description=read('README.rst'),
+    license='Apache License, Version 2.0',
     packages=find_packages(exclude=['tests']),
+    zip_safe=False,
     install_requires=[
         'Henson>=0.2.0',
         'structlog',
     ],
     tests_require=[
-        'tox',
+        'pytest',
     ],
+    cmdclass={
+        'test': PyTest,
+    },
     classifiers=[
         'Development Status :: 4 - Beta',
         'Intended Audience :: Developers',