Setup tweaks

Author: jenisys

MANIFEST.in

@@ -1,23 +1,29 @@
 include MANIFEST.in
+include LICENSE
 include setup.py
 include *.txt
 include *.rst
 include *.ini
-include *.cmd
-include .bumversion.cfg
+include .bumpversion.cfg
 include .coveragerc
 include .pylintrc
-include docs/Makefile
-recursive-include click_configfile *.py
-recursive-include docs     *.py *.rst *.txt *.css *.json *.in make.bat
+
 recursive-include tests    *.txt *.py *.ini
-recursive-include bin      *.py *.cmd *.zip
-recursive-include tasks/   *.py
+recursive-include tasks    *.py  *.txt *.rst
+recursive-include py.requirements   *.txt
+# MAYBE: recursive-include tasks/   *.py *.zip
 
+# include click_configfile.py
+# PREPARED: recursive-include click_configfile *.py
+# PREPARED: include *.cmd
+# PREPARED: recursive-include bin      *.py *.cmd *.zip
+# PREPARED: recursive-include docs     *.py *.rst *.txt *.css *.json *.in make.bat
+# PREPARED: include docs/Makefile
 # MAYBE: include bin/behave
 # MAYBE: recursive-include features  *.feature *.py *.txt
 # MAYBE: recursive-include lib      *.py *.pth *.zip *.egg
 
+recursive-exclude _* *.*
 recursive-exclude .git *.*
 recursive-exclude .tox *.*
 recursive-exclude .venv* *.*

README.rst

@@ -160,6 +160,7 @@ The resulting source code is:
 
 .. code-block:: python
 
+    # MARKER-EXAMPLE:
     # -- FILE: example_command_with_configfile.py (ALL PARTS: simplified)
     from click_configfile import ConfigFileReader, Param, SectionSchema
     from click_configfile import matches_section

setup.cfg

@@ -1,3 +1,8 @@
+# -- CONVENIENCE: Use pytest-runner (ptr) as test runner.
+[aliases]
+docs = build_sphinx
+test = pytest
+
 [sdist]
 formats = zip, gztar, bztar
 

setup.py

@@ -6,6 +6,7 @@
     python setup.py install
 """
 
+from __future__ import print_function
 import sys
 import os.path
 
@@ -15,6 +16,7 @@
 sys.path.insert(0, HERE)
 
 from setuptools import find_packages, setup
+import inspect
 # MAYBE: from setuptools_behave import behave_test
 
 # -----------------------------------------------------------------------------
@@ -30,20 +32,50 @@ def find_packages_by_root_package(where):
     packages.insert(0, root_package)
     return packages
 
+def make_long_description(marker=None, intro=None):
+    """
+    This package extends the click_ functionality by adding support for commands
+    that use configuration files.
+
+    .. _click: https://click.pocoo.org/
+
+
+    .. code-block:: python
+
+        # EXAMPLE:
+    """
+    if intro is None:
+        intro = inspect.getdoc(make_long_description)
+
+    with open("README.rst", "r") as infile:
+        line = infile.readline()
+        while not line.strip().startswith(marker):
+            line = infile.readline()
+
+        # -- COLLECT REMAINING: Usage example
+        contents = infile.read()
+
+    text = intro +"\n" + contents
+    return text
+
+# -- FILE: example_command_with_configfile.py (ALL PARTS: simplified)
 
 # ----------------------------------------------------------------------------
 # PROJECT CONFIGURATION (for sdist/setup mostly):
 # ----------------------------------------------------------------------------
-install_requires = [ "click >= 6.6" ]
+install_requires = ["click >= 6.6", "six >= 1.10"]
 before_py35_extra = []
 if sys.version < "3.5":
-    install_requires.append("configparser")
-    before_py35_extra.append("configparser")
+    install_requires.append("configparser >= 3.5.0")
+    before_py35_extra.append("configparser >= 3.5.0")
+
+EXAMPLE_MARKER = "# MARKER-EXAMPLE:"
+long_description = make_long_description(EXAMPLE_MARKER)
+SETUP_DEBUG = os.environ.get("SETUP_DEBUG", "no") in ("yes", "true", "on")
+if SETUP_DEBUG:
+    print(long_description)
 
-README = os.path.join(HERE, "README.rst")
-long_description = "".join(open(README).readlines()[4:])
 
-NAME = "click-configfile"
 CLASSIFIERS = """\
 License :: OSI Approved :: BSD License
 Development Status :: 3 - Alpha
@@ -82,8 +114,10 @@ def find_packages_by_root_package(where):
     platforms  = [ 'any' ],
     classifiers= CLASSIFIERS.splitlines(),
     # packages = find_packages_by_root_package("click_configfile"),
-    modules = ["click_configfile"],
+    py_modules = ["click_configfile"],
     install_requires=install_requires,
+    setup_requires=["pytest-runner"],
+    tests_require=["pytest >= 3.0"],
     include_package_data=True,
     extras_require={
         # -- SUPPORT-WHEELS: Extra packages for Python2.6