Added pyproject.toml, improved mkdocs.md, and fixed travis builds so that deployment works again. Added python 3.8 in the builds. Deploy env is now 3.7

Author: Sylvain MARIE

.travis.yml

@@ -5,10 +5,19 @@ cache: pip
 matrix:
   fast_finish: true
   include:
-    - python: 2.7
-    - python: 3.5
-    - python: 3.6
-    - python: 3.7
+    - name: "Python 2.7"
+      python: 2.7
+    - name: "Python 3.5"
+      python: 3.5
+    - name: "Python 3.6"
+      python: 3.6
+    - name: "Python 3.7 - DEPLOY WebSite+Coverage+PyPi"
+      python: 3.7
+      env: DEPLOY_ENV="true"
+      dist: xenial
+      sudo: true
+    - name: "Python 3.8"
+      python: 3.8
       dist: xenial
       sudo: true
 
@@ -23,34 +32,34 @@ before_install:
 
 install:
   - pip list
-  - pip install setuptools_scm  # apparently python 2 requires this
+  # Install all requirements using pip
+  - pip install setuptools_scm  # apparently python 2 requires this done beforehand
   - python ci_tools/py_install.py pip ci_tools/requirements-pip.txt
-  # this does not work anymore on python 2 so lets only do it when needed
-  - if [ "${TRAVIS_PYTHON_VERSION}" = "3.5" ]; then pip install mkdocs-material mkdocs; fi;
+  # mkdocs requirements: this does not work anymore on python 2 so lets only do it when needed
+  - if [ "${DEPLOY_ENV}" = "true" ]; then pip install mkdocs-material mkdocs pymdown-extensions pygments; fi;
+#  - if [ ! "${TRAVIS_PYTHON_VERSION}" = "2.7" ]; then pip install doit; fi;
   # travis-specific installs
   - pip install PyGithub  # for ci_tools/github_release.py
   - pip install codecov  # See https://github.com/codecov/example-python.
   - pip list
 
 script:
-#  - coverage run tests.py
+  # Local installation test
   - pip install .
   - python -c "import os; os.chdir('..'); import getversion"
   - pip uninstall -y getversion  # so that the setuptools_scm test can be executed
-# ***tests***
-#  - coverage run tests.py
-#  - pytest --junitxml=reports/junit/junit.xml --html=reports/junit/report.html --cov-report term-missing --cov=./getversion -v getversion/tests/
-# now done in a dedicated script to capture exit code 1 and transform it to 0
+  # ***tests+coverage*** done in a dedicated script to capture exit code 1 and transform it to 0
   - chmod a+x ./ci_tools/run_tests.sh
   - sh ./ci_tools/run_tests.sh
-  - python ci_tools/generate-junit-badge.py 100  # generates the badge for the test results and fail build if less than x%
+  # generate the badge for the test results and fail build if less than x%
+  - python ci_tools/generate-junit-badge.py 100
 
 after_success:
-# ***reporting***
-#  - junit2html junit.xml testrun.html  output is really not nice
+  # ***reporting***
+  # - junit2html junit.xml testrun.html  output is really not nice
   - ant -f ci_tools/generate-junit-html.xml  # generates the html for the test results. Actually we dont use it anymore
   - codecov
-  # - pylint getversion  # note that at the moment the report is simply lost, we dont transform the result into anything
+  # - pylint getversion  # at the moment the report would be simply lost, we dont transform the result into anything
 # ***documentation***
   - mkdocs build -f docs/mkdocs.yml
   - mv reports/junit docs/  # not in site/ anymore so that we do not need to use --dirty (it breaks client-side search)
@@ -69,7 +78,7 @@ after_success:
       git fetch gh-remote && git fetch gh-remote gh-pages:gh-pages;  # make sure we have the latest gh-remote
       # push but only if this is not a build triggered by a pull request
       # note: do not use the --dirty flag as it breaks client-side search
-      if [ "${TRAVIS_PULL_REQUEST}" = "false" ] && [ "${TRAVIS_PYTHON_VERSION}" = "3.5" ]; then echo "Pushing to github"; PYTHONPATH=getversion/ mkdocs gh-deploy -v -f docs/mkdocs.yml --remote-name gh-remote; git push gh-remote gh-pages; fi;
+      if [ "${TRAVIS_PULL_REQUEST}" = "false" ] && [ "${DEPLOY_ENV}" = "true" ]; then echo "Pushing to github"; PYTHONPATH=getversion/ mkdocs gh-deploy -v -f docs/mkdocs.yml --remote-name gh-remote; git push gh-remote gh-pages; fi;
     else
       echo "File 'ci_tools/github_travis_rsa' has not been created, please check your encrypted repo token in .travis.yml, on the line starting with 'openssl aes-256-cbc...'"
     fi
@@ -84,8 +93,8 @@ deploy:
       secure: "yaf389gcod/g9nvHtgt4AHuHi2qeVljwuHOTb5l4N2dkoGQz+UZiEiXY80+KcZ3XPHcE2MsrFNO2rKqHVCOjwvtrZCNjM9w2Zk+jBAyOKKx1SICWbfzvhlZN0pSNee6+805N6MrlzJ3SlgtsJeMjLttrh51Zrh2LsashSDI9YNVRG1a5iB6k8LOCp+5PZcuhh9qA0tWxQdxDU/NGcazGx97nrjT+xHaQ1agDt/h9wOZoLlUK+A1TnVesXF8k1DC6sirPmtvF5fCKOFniHZwFV2hS/htEgCuK5fpjheD6nGKNguUw88wiHTCNIuebyqaab79HPrWUNNpoOfJ8sSecJs0d9Kf647AueN8XX3KSDyhs4P+JwtRaAYCsVkqKbqyxlxE6bxe1KoRFREqk9mrad/ify/N9Cwrc02vkuJu3mBNZciO8oqosY1xRlvQQxz+p201eaads8cIMfzJkRVbIF8QC2ADfH9uGnwp1St6lBDx88+ZtM9LvPIzaQsvMXAqvA5mN4TlFBFxDuYDnL6C/sPAfk+Mc8hRWQ0CA2lwRQbLkQXI0VF0QpIAJbNIDrE8apYDVGZ6wZsy+TP5v9yxR2CM3mB+qzX71kYsvNHB3DlK89PXhRt/qLnY4+lhiIwC24YsOiS3KRQlWrE+3fi/8TzNjsrFV/UAnzW9jQk9WkeY="
     on:
       tags: true
-      python: 3.5  #only one of the builds have to be deployed
-      # condition: $PYTEST_VERSION = "<3"
+      # python: 3.5  #only one of the builds have to be deployed
+      condition: $DEPLOY_ENV = "true"
     # server: https://test.pypi.org/legacy/
     distributions: "sdist bdist_wheel"
 
@@ -95,8 +104,8 @@ deploy:
     skip_cleanup: true
     on:
       tags: true
-      python: 3.5  #only one of the builds have to be deployed
-      # condition: $PYTEST_VERSION = "<3"
+      # only one of the builds have to be deployed
+      condition: $DEPLOY_ENV = "true"
 
 notifications:
   email:

ci_tools/requirements-pip.txt

@@ -15,5 +15,6 @@ pytest-html==1.9.0  # otherwise requires pytest 5
 xunitparser
 
 # --- to generate the doc (see .travis)
+# does not work on python 2 anymore
 # mkdocs-material  # ==2.7.3
 # mkdocs  # ==0.17.3  # this is to prevent a version non-compliant with mkdocs-material to be installed.

ci_tools/run_tests.sh

@@ -12,10 +12,10 @@ cleanup() {
 
 trap "cleanup" INT TERM EXIT
 
-if [ "${TRAVIS_PYTHON_VERSION}" = "3.5" ]; then
+if [ "${DEPLOY_ENV}" = "true" ]; then
    # full
    # Run tests with "python -m pytest" to use the correct version of pytest
-   echo -e "\n\n****** Running tests ******\n\n"
+   echo -e "\n\n****** Running tests with coverage ******\n\n"
    coverage run --source getversion -m pytest --junitxml=reports/junit/junit.xml --html=reports/junit/report.html -v getversion/tests/
    # buggy
    # python -m pytest --junitxml=reports/junit/junit.xml --html=reports/junit/report.html --cov-report term-missing --cov=./getversion -v getversion/tests/

docs/mkdocs.yml

@@ -7,12 +7,13 @@ nav:
     - Home: index.md
     # - API reference: api_reference.md
     - Changelog: changelog.md
-
 theme: material  # readthedocs  mkdocs
 
 markdown_extensions:
+  - pymdownx.highlight  # see https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#highlight
+  - pymdownx.superfences # same as above as well as code blocks inside other blocks
   - admonition  # to add notes such as http://squidfunk.github.io/mkdocs-material/extensions/admonition/
-  - codehilite:
-      guess_lang: true
+#  - codehilite:
+#      guess_lang: false
   - toc:
-      permalink: true
+      permalink: true

pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools",
+    "setuptools_scm",
+]
+build-backend = "setuptools.build_meta"