Moving to invoke & versioneer !nocl

pyinvoke for running tasks
versioneer for version reporting
some test skips on unsupported platforms.

Author: rasjani

.gitattributes

@@ -0,0 +1 @@
+webdrivermanager/_version.py export-subst

MANIFEST.in

@@ -1,2 +1,4 @@
-include requirements*.txt CHANGELOG README.rst LICENSE
-exclude dodo.py .gitignore azure-pipelines.yml azure/* test/*
+include requirements.txt CHANGELOG README.rst LICENSE
+exclude tasks.py .gitignore azure-pipelines.yml azure/* test/*
+include versioneer.py
+include webdrivermanager/_version.py

dodo.py

@@ -0,0 +1,10 @@
+# Global options:
+
+[mypy]
+python_version = 3.7
+warn_return_any = False
+warn_unused_configs = True
+python_executable = python
+ignore_missing_imports = True
+files=webdrivermanager/*.py
+# Per-module options:

mypy.ini

@@ -12,14 +12,14 @@ pylint_junit; python_version >= '3.4'
 python-language-server[all]
 backports.tempfile; python_version < '3.0'
 coverage
-doit==0.29; python_version < '3.0'
-doit>0.29; python_version > '3.0'
 unittest-xml-reporting; python_version > '3.0'
 unittest-xml-reporting==2.5.2; python_version < '3.0'
+invoke
 flaky
 pyfakefs==3.5.2
-git+https://github.com/rasjani/gitchangelog.git@fix-115
+gcg
 tox
 tox-pyenv
 tox-venv
+mypy
 -r requirements.txt

requirements-dev.txt

@@ -46,3 +46,10 @@ length_sort=1
 forced_separate=
 default_section=FIRSTPARTY
 no_lines_before=LOCALFOLDER
+
+[versioneer]
+VCS = git
+style = pep440
+versionfile_source = webdrivermanager/_version.py
+versionfile_build = webdrivermanager/_version.py
+tag_prefix =

setup.cfg

@@ -4,6 +4,7 @@
 from os.path import join, abspath, dirname
 
 from setuptools import setup
+import versioneer
 
 CWD = abspath(dirname(__file__))
 PACKAGE_NAME='webdrivermanager'
@@ -14,8 +15,6 @@
 
 # Get version
 CWD = abspath(dirname(__file__))
-VERSION_PATH = join(CWD, PACKAGE_NAME, 'version.py')
-exec(compile(open(VERSION_PATH).read(), VERSION_PATH, 'exec'))
 
 with open(join(CWD, 'requirements.txt'), encoding="utf-8") as f:
     REQUIREMENTS = f.read().splitlines()
@@ -44,7 +43,8 @@
 '''.strip().splitlines()
 
 setup(name=PACKAGE_NAME,
-      version=VERSION,
+      version=versioneer.get_version(),
+      cmdclass=versioneer.get_cmdclass(),
       description='Module for facilitating download and deploy of WebDriver binaries.',
       long_description=long_description,
       classifiers=CLASSIFIERS,

setup.py

@@ -0,0 +1,89 @@
+# flake8: noqa
+from pathlib import Path
+from invoke import task
+from pathlib import Path
+import os
+import shutil
+
+
+QUOTE = "\"" if os.name == "nt" else "'"
+
+CHANGELOG = "CHANGELOG"
+filters = ["poc", "new release", "wip", "cleanup", "!nocl"]
+
+
+def filter_entries(filename):
+    buffer = []
+    with open(filename) as old_file:
+        buffer = old_file.read().split("\n")
+
+    with open(filename, "w") as new_file:
+        for line in buffer:
+            if not any(bad_word in line.lower() for bad_word in filters):
+                new_file.write(line + "\n")
+
+
+assert Path.cwd() == Path(__file__).parent
+
+
+@task()
+def build(ctx):
+    """Generates dist tar ball"""
+    ctx.run("python setup.py sdist")
+
+@task
+def flake(ctx):
+    """Runs flake8 against whole project"""
+    ctx.run("flake8")
+
+
+@task
+def mypy(ctx):
+    """Runs mypy against the codebase"""
+    ctx.run("mypy --config mypy.ini")
+
+
+@task
+def black(ctx):
+    """Reformat code with black"""
+    ctx.run("black -l130 -tpy37 src")
+
+
+@task
+def clean(ctx):
+    to_be_removed = [
+        "report",
+        "dist/",
+        ".coverage*",
+        "output*",
+    ]
+
+    for item in to_be_removed:
+        fs_entry = Path(item)
+        if fs_entry.is_dir:
+            shutil.rmtree(item)
+        elif fs_entry.is_file():
+            fs_entry.unlink()
+        else:
+            for fs_entry in Path().glob(item):
+                fs_entry.unlink()
+
+
+@task
+def changelog(ctx, version=None):
+    if version is not None:
+        version = f"-c {version}"
+    else:
+        version = ""
+    ctx.run(f"gcg -x -o {CHANGELOG} -O rpm {version}")
+    filter_entries(CHANGELOG)
+
+
+@task
+def release(ctx, version=None):
+    assert version != None
+    changelog(ctx, version)
+    ctx.run(f"git add {CHANGELOG}")
+    ctx.run(f"git commit -m {QUOTE}New Release {version}{QUOTE}")
+    ctx.run(f"git tag {version}")
+    build(ctx)

tasks.py

@@ -4,7 +4,7 @@
 from os import mkdir
 from os.path import join, isfile, abspath, dirname
 from unittest import TestCase
-from unittest import skipIf
+from unittest import skipUnless
 from unittest import main as run_tests
 from flaky import flaky
 
@@ -232,14 +232,14 @@ def test_download_and_install(self):
 class EdgeChromiumDriverManagerTestsWithAutomaticLocations(AutomaticBaseTest):
     DRIVER_MANAGER = webdrivermanager.EdgeChromiumDriverManager
 
-    @skipIf(sys.platform.startswith("lin"), "No EdgeChromium for linux")
+    @skipUnless(sys.platform.startswith("win"), "No EdgeChromium on this platform")
     @flaky
     def test_download(self):
         self.instance = self.DRIVER_MANAGER()
         filename = self.instance.download(show_progress_bar=False)
         self.assertTrue(isfile(filename), 'Downloading and saving seems to have failed')
 
-    @skipIf(sys.platform.startswith("lin"), "No EdgeChromium for linux")
+    @skipUnless(sys.platform.startswith("win"), "No EdgeChromium on this platform")
     @flaky
     def test_download_and_install(self):
         self.instance = self.DRIVER_MANAGER()
@@ -251,14 +251,14 @@ def test_download_and_install(self):
 class EdgeChromiumDriverManagerTestsWithExplicitLocations(ExplicitBaseTest):
     DRIVER_MANAGER = webdrivermanager.EdgeChromiumDriverManager
 
-    @skipIf(sys.platform.startswith("lin"), "No EdgeChromium for linux")
+    @skipUnless(sys.platform.startswith("win"), "No EdgeChromium on this platform")
     @flaky
     def test_download(self):
         self.instance = self.DRIVER_MANAGER(download_root=self.temp_dir.name)
         filename = self.instance.download(show_progress_bar=False)
         self.assertTrue(isfile(filename), 'Downloading and saving seems to have failed')
 
-    @skipIf(sys.platform.startswith("lin"), "No EdgeChromium for linux")
+    @skipUnless(sys.platform.startswith("win"), "No EdgeChromium on this platform")
     @flaky
     def test_download_and_install(self):
         link_path = self.make_link_dir()