- Added __version__ attribute

 - Not using pytest-cov anymore: bug
 - simplified setup.py thanks to markdown-enabled long description

Author: Sylvain MARIE

autoclass/__init__.py

@@ -7,7 +7,17 @@
     autoprops_decorate, DuplicateOverrideError, getter_override, setter_override, autoprops_override_decorate
 from autoclass.utils import AutoclassDecorationException
 
+try:
+    # Distribution mode : import from _version.py generated by setuptools_scm during release
+    from ._version import version as __version__
+except ImportError:
+    # Source mode : use setuptools_scm to get the current version from src using git
+    from setuptools_scm import get_version as _gv
+    from os import path as _path
+    __version__ = _gv(_path.join(_path.dirname(__file__), _path.pardir))
+
 __all__ = [
+    '__version__',
     # submodules
     'autoargs_', 'autoclass_', 'autodict_', 'autohash_', 'autoprops_', 'utils',
     # symbols

ci_tools/run_tests.sh

@@ -22,7 +22,9 @@ trap "cleanup" INT TERM EXIT
 echo -e "\n\n****** Running tests ******\n\n"
 if [ "${TRAVIS_PYTHON_VERSION}" = "3.5" ]; then
    # full
-   python -m pytest --junitxml=reports/junit/junit.xml --html=reports/junit/report.html --cov-report term-missing --cov=./autoclass -v autoclass/tests/
+   coverage run --source autoclass -m pytest --junitxml=reports/junit/junit.xml --html=reports/junit/report.html --cov-report term-missing --cov=./autoclass -v autoclass/tests/
+   # buggy
+   # python -m pytest --junitxml=reports/junit/junit.xml --html=reports/junit/report.html --cov-report term-missing --cov=./autoclass -v autoclass/tests/
 else
    # faster - skip coverage and html report
    python -m pytest --junitxml=reports/junit/junit.xml -v autoclass/tests/

docs/changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### 1.17.2 - Added `__version__` attribute
+
+Added `__version__` attribute at package level.
+
 ### 1.17.1 - Fixed bug with latest `valid8`
 
  * Fixed `ValidationError` happening in all use cases. Fixed [#25](https://github.com/smarie/python-autoclass/issues/25).

setup.py

@@ -14,7 +14,7 @@
 INSTALL_REQUIRES = ['decopatch', 'funcsigs;python_version<"3.3"', 'valid8', 'makefun']
 DEPENDENCY_LINKS = []
 SETUP_REQUIRES = ['pytest-runner', 'setuptools_scm', 'pypandoc', 'pandoc']
-TESTS_REQUIRE = ['pytest', 'pytest-logging', 'pytest-cov', 'PyContracts', 'enforce', 'pytypes', 'valid8>=2.0.0']
+TESTS_REQUIRE = ['pytest', 'pytest-logging', 'PyContracts', 'enforce', 'pytypes', 'valid8>=2.0.0']
 EXTRAS_REQUIRE = {'contracts': ['PyContracts'],
                   'enforce': ['enforce'],
                   'validate': ['valid8']}
@@ -23,9 +23,7 @@
 try:
     from setuptools_scm import get_version
 except Exception as e:
-    raise_from(Exception('Required packages for setup not found. You may wish you execute '
-                         '"pip install -r ci_tools/requirements-setup.txt" to install them or alternatively install '
-                         'them manually using conda or other system. The list is : ' + str(SETUP_REQUIRES)), e)
+    raise_from(Exception('Required packages for setup not found. Please install `setuptools_scm`'), e)
 
 # ************** ID card *****************
 DISTNAME = 'autoclass'
@@ -42,17 +40,9 @@
 KEYWORDS = 'auto code generator getter setter constructor autoarg autoprops decorator property properties fields ' \
            'attribute attr contract object class enforce valid boilerplate pep484 type-hints runtime-typechecking ' \
            'typechecking'
-# --Get the long description from the README file
-# with open(path.join(here, 'README.md'), encoding='utf-8') as f:
-#    LONG_DESCRIPTION = f.read()
-try:
-    import pypandoc
-    LONG_DESCRIPTION = pypandoc.convert(path.join(here, 'docs', 'long_description.md'), 'rst').replace('\r', '')
-except(ImportError):
-    from warnings import warn
-    warn('WARNING pypandoc could not be imported - we recommend that you install it in order to package the '
-         'documentation correctly')
-    LONG_DESCRIPTION = open('README.md').read()
+
+with open(path.join(here, 'docs', 'long_description.md')) as f:
+    LONG_DESCRIPTION = f.read()
 
 # ************* VERSION **************
 # --Get the Version number from VERSION file, see https://packaging.python.org/single_source_version/ option 4.
@@ -65,6 +55,7 @@
     name=DISTNAME,
     description=DESCRIPTION,
     long_description=LONG_DESCRIPTION,
+    long_description_content_type='text/markdown',
 
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
@@ -125,7 +116,7 @@
     dependency_links=DEPENDENCY_LINKS,
 
     # we're using git
-    use_scm_version=True, # this provides the version + adds the date if local non-commited changes.
+    use_scm_version={'write_to': '%s/_version.py' % DISTNAME}, # this provides the version + adds the date if local non-commited changes.
     # use_scm_version={'local_scheme':'dirty-tag'}, # this provides the version + adds '+dirty' if local non-commited changes.
     setup_requires=SETUP_REQUIRES,