Refactored setup and __version__ single-sourcing.

Author: insightindustry

.gitignore

@@ -92,6 +92,7 @@ celerybeat-schedule
 .venv
 venv/
 .python27
+.clean
 ENV/
 .activate.ps1
 

MANIFEST.in

@@ -1,8 +1,9 @@
-# Include the README
-include *.md
-
 # Include the LICENSE file
 include LICENSE
 
 # Include the VERSION file
-include VERSION
+# include VERSION
+
+# Include the README file
+include README.rst
+include _README.md

README.rst

@@ -1,11 +1,8 @@
-.. Validator Collection documentation master file, created by
-   sphinx-quickstart on Sat Apr 14 11:13:03 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
-####################################################
+
+======================
 Validator Collection
-####################################################
+======================
 
 **Python library of 60+ commonly-used validator functions**
 
@@ -91,9 +88,7 @@ Available Validators and Checkers
 Validators
 =============
 
-.. seealso::
-
-  Please see the `Validator Reference <http://validator-collection.readthedocs.io/en/latest/validators.html>`_
+Please see the `Validator Reference <http://validator-collection.readthedocs.io/en/latest/validators.html>`_
 
 .. list-table::
   :widths: 30 30 30 30 30
@@ -143,9 +138,7 @@ Validators
 Checkers
 ==========
 
-.. sealso::
-
-  Please see the `Checker Reference <http://validator-collection.readthedocs.io/en/latest/checkers.html>`_
+Please see the `Checker Reference <http://validator-collection.readthedocs.io/en/latest/checkers.html>`_
 
 .. list-table::
   :widths: 30 30 30 30 30
@@ -266,9 +259,7 @@ two flavors: a validator and a checker.
 Using Validators
 ==================
 
-.. sealso::
-
-  Please see the `Validator Reference <http://validator-collection.readthedocs.io/en/latest/validators.html>`_
+Please see the `Validator Reference <http://validator-collection.readthedocs.io/en/latest/validators.html>`_
 
 A validator does what it says on the tin: It validates that an input value is
 what you think it should be, and returns its valid form.
@@ -322,9 +313,7 @@ and what can cause them, please review the `Validator Reference <http://validato
 Using Checkers
 ================
 
-.. seealso::
-
-  Please see the `Checker Reference <http://validator-collection.readthedocs.io/en/latest/checkers.html>`_
+Please see the `Checker Reference <http://validator-collection.readthedocs.io/en/latest/checkers.html>`_
 
 Likewise, a checker is what it sounds like: It checks that an input value
 is what you expect it to be, and tells you ``True``/``False`` whether it is or not.

VERSION

@@ -1,3 +1,5 @@
+
+
 # Validator Collection
 **Python library of 60+ commonly-used validator functions**
 

_README.md

@@ -31,7 +31,7 @@
 # The short X.Y version
 version = '1.0'
 # The full version, including alpha/beta/rc tags
-release = '1.0.0rc1'
+release = '1.0.0rc10'
 
 
 # -- General configuration ---------------------------------------------------

docs/conf.py

@@ -1,5 +1,6 @@
 [metadata]
 license_file = LICENSE
+description_file = README.md
 
 [bdist_wheel]
 # This flag says to generate wheels that support both Python 2 and Python

setup.cfg

@@ -5,6 +5,8 @@
 https://github.com/pypa/sampleproject
 """
 
+import sys
+
 # Always prefer setuptools over distutils
 from setuptools import setup, find_packages
 # To use a consistent encoding
@@ -18,12 +20,17 @@
     long_description = f.read()
 
 # Get the version number from the VERSION file
-with open(path.join(here, 'VERSION'), encoding='utf-8') as f:
-    version = f.read().strip()
+version_dict = {}
+with open('./validator_collection/_version.py') as version_file:
+    exec(version_file.read(), version_dict)                                     # pylint: disable=W0122
+
+version = version_dict.get('__version__')
 
 # Arguments marked as "Required" below must be included for upload to PyPI.
 # Fields marked as "Optional" may be commented out.
 
+
+
 setup(
     # This is the name of your project. The first time you publish this
     # package, this name will be registered for you. It will determine how
@@ -139,8 +146,8 @@
     # For an analysis of "install_requires" vs pip's requirements files see:
     # https://packaging.python.org/en/latest/requirements.html
     install_requires=[
-        "regex ; python_version<'3'"
-    ],  # Optional
+        'regex;python_version<"3"',
+    ],
 
     # List additional groups of dependencies here (e.g. development
     # dependencies). Users will be able to install these using the "extras"
@@ -162,16 +169,24 @@
     #
     # If using Python 2.6 or earlier, then these have to be included in
     # MANIFEST.in as well.
-    #package_data={  # Optional
-    #    'sample': ['package_data.dat'],
+    #package_data={
+    #    '': ['_README.rst', 'README.md'],
+    #    '': ['LICENSE', 'VERSION'],
     #},
 
+    #include_package_data = True,
+
     # Although 'package_data' is the preferred approach, in some case you may
     # need to place data files outside of your packages. See:
     # http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files
     #
     # In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
     #data_files=[('my_data', ['data/data_file'])],  # Optional
+    #data_files = [
+    #    ('validator_collection', ['LICENSE']),
+    #    ('validator_collection', ['README.md']),
+    #    ('validator_collection', ['VERSION']),
+    #],
 
     # To provide executable scripts, use entry points in preference to the
     # "scripts" keyword. Entry points provide cross-platform support and allow

setup.py

@@ -10,9 +10,13 @@
 
 import os
 
-with open(os.path.join(os.path.dirname(os.path.dirname(__file__)),
-                       'VERSION')) as version_file:
-    __version__ = version_file.read().strip()
+# Get the version number from the _version.py file
+version_dict = {}
+with open(os.path.join(os.path.dirname(__file__), '_version.py')) as version_file:
+    exec(version_file.read(), version_dict)                                     # pylint: disable=W0122
+
+__version__ = version_dict.get('__version__')
+
 
 from validator_collection.validators import bytesIO, date, dict, decimal, \
     directory_exists, datetime, email, float, fraction, file_exists, ip_address, \

validator_collection/__init__.py

@@ -15,8 +15,6 @@
 from fractions import Fraction
 import time as time_
 
-import chardet
-
 _ver = sys.version_info
 
 #: Python 2.x?

validator_collection/_compat.py

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+__version__ = '0.1.1rc1'