Added __version__ package-level attribute.

Removed pypandoc dependency
Got rid of pytest-cov
Fixed pytest-html version

Author: Sylvain MARIE

ci_tools/requirements-pip.txt

@@ -1,8 +1,6 @@
 # --- to execute setup.py whatever the goal
 setuptools_scm
 pytest-runner
-pandoc
-pypandoc
 
 # --- to install
 pyyaml$PYYAML_VERSION
@@ -12,8 +10,8 @@ pytest  #$PYTEST_VERSION
 pytest-logging  # ==2015.11.4
 
 # --- to generate the reports (see scripts in ci_tools, called by .travis)
-pytest-cov==2.6.0  # after 2.6.1 it requires pytest 3.6
-pytest-html  #$PYTEST_HTML_VERSION
+# pytest-cov==2.6.0  # after 2.6.1 it requires pytest 3.6
+pytest-html==1.9.0  # otherwise requires pytest 5
 xunitparser
 
 # --- to generate the doc (see .travis)

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=./yamlable -v yamlable/tests/
+   coverage run --source yamlable -m pytest --junitxml=reports/junit/junit.xml --html=reports/junit/report.html -s -v yamlable/tests/
+   # buggy
+   # python -m pytest --junitxml=reports/junit/junit.xml --html=reports/junit/report.html --cov-report term-missing --cov=./yamlable -v yamlable/tests/
 else
    # faster - skip coverage and html report
    python -m pytest --junitxml=reports/junit/junit.xml -v yamlable/tests/

setup.py

@@ -13,8 +13,8 @@
 # *************** Dependencies *********
 INSTALL_REQUIRES = ['pyyaml']
 DEPENDENCY_LINKS = []
-SETUP_REQUIRES = ['pytest-runner', 'setuptools_scm', 'pypandoc', 'pandoc']
-TESTS_REQUIRE = ['pytest', 'pytest-logging', 'pytest-cov']
+SETUP_REQUIRES = ['pytest-runner', 'setuptools_scm']
+TESTS_REQUIRE = ['pytest', 'pytest-logging']
 EXTRAS_REQUIRE = {}
 
 # simple check
@@ -36,17 +36,9 @@
 DOWNLOAD_URL = URL + '/tarball/' + version_for_download_url
 
 KEYWORDS = 'yaml file parsing parse load dump read write object oo oriented codec format plugin pyYaml'
-# --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.
@@ -59,6 +51,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
@@ -119,7 +112,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,
 

yamlable/__init__.py

@@ -1,21 +1,38 @@
+from yamlable.base import AbstractYamlObject, NONE_IGNORE_CHECKS, read_yaml_node_as_dict
+from yamlable.main import YamlCodec, register_yamlable_codec, yaml_info_decorate, yaml_info, YamlAble, \
+    AbstractYamlAble, YAMLABLE_PREFIX
+from yamlable.yaml_objects import YamlObject2, ABCYAMLMeta, YAMLObjectMetaclassStrict
+
+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
+    'base', 'main', 'yaml_objects',
+    # symbols
+    'AbstractYamlObject', 'NONE_IGNORE_CHECKS', 'read_yaml_node_as_dict',
+    'YamlCodec', 'register_yamlable_codec', 'yaml_info_decorate', 'yaml_info', 'YamlAble', 'AbstractYamlAble',
+    'YAMLABLE_PREFIX',
+    'YamlObject2', 'ABCYAMLMeta', 'YAMLObjectMetaclassStrict'
+]
+
 try:  # python 3.5+
     from yamlable.base import Y
+    __all__.append('Y')
 except ImportError:
     pass
-from yamlable.base import AbstractYamlObject, NONE_IGNORE_CHECKS, read_yaml_node_as_dict
 
 try:  # python 3.5+
     from yamlable.main import YA
+    __all__.append('YA')
 except ImportError:
     pass
-from yamlable.main import YamlCodec, register_yamlable_codec, yaml_info_decorate, yaml_info, YamlAble, \
-    AbstractYamlAble, YAMLABLE_PREFIX
-
-from yamlable.yaml_objects import YamlObject2, ABCYAMLMeta, YAMLObjectMetaclassStrict
-
-__all__ = ['base', 'main', 'yaml_objects',
-           'AbstractYamlObject', 'NONE_IGNORE_CHECKS', 'Y', 'read_yaml_node_as_dict',
-           'YamlCodec', 'register_yamlable_codec', 'yaml_info_decorate', 'yaml_info', 'YamlAble', 'YA',
-           'AbstractYamlAble',
-           'YAMLABLE_PREFIX', 'YamlObject2', 'ABCYAMLMeta', 'YAMLObjectMetaclassStrict'
-           ]