Merge pull request #3 from mdmintz/refactoring

Refactoring

Author: mdmintz

.github/workflows/python-package.yml

@@ -1,13 +1,16 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# This workflow will install Python dependencies, run tests, and lint with a variety of Python versions.
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: Python package
+name: CI build
 
 on:
-  push:
-    branches: [ master ]
   pull_request:
-    branches: [ master ]
+    branches:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+    branches:
 
 jobs:
   build:
@@ -19,7 +22,7 @@ jobs:
       fail-fast: false
       max-parallel: 6
       matrix:
-        python-version: [2.7, 3.5, 3.6, 3.7, 3.8, 3.9]
+        python-version: ["2.7", "3.6", "3.7", "3.8", "3.9", "3.10"]
 
     steps:
     - uses: actions/checkout@v2

.gitignore

@@ -72,6 +72,7 @@ geckodriver
 msedgedriver
 operadriver
 MicrosoftWebDriver.exe
+headless_ie_selenium.exe
 IEDriverServer.exe
 chromedriver.exe
 geckodriver.exe
@@ -124,15 +125,21 @@ images_exported
 # Cookies
 saved_cookies
 
+# Recordings
+recordings
+
 # Automated Visual Testing
 visual_baseline
 
-# MkDocs
+# MkDocs WebSite Generator
 site/*
-docs/*.md
-docs/*/*.md
-docs/*/*/*.md
-docs/*/*/*/*.md
+mkdocs_build/*.md
+mkdocs_build/*/*.md
+mkdocs_build/*/*/*.md
+mkdocs_build/*/*/*/*.md
+
+# macOS system files
+.DS_Store
 
 # Other
 selenium-server-standalone.jar

CODE_OF_CONDUCT.md

@@ -0,0 +1,23 @@
+# Code of conduct
+
+(sbVirtualDisplay uses a modified version of [Flutter's Code of conduct](https://github.com/flutter/flutter/blob/master/CODE_OF_CONDUCT.md))
+
+The sbVirtualDisplay project expects sbVirtualDisplay's contributors to act professionally and respectfully. sbVirtualDisplay contributors are expected to maintain the safety and dignity of sbVirtualDisplay's social environments.
+
+Specifically:
+
+* Respect people, their identities, their culture, and their work.
+* Be kind. Be courteous. Be welcoming.
+* Listen. Consider and acknowledge people's points before responding.
+
+Should you experience anything that makes you feel unwelcome in sbVirtualDisplay's community, please [contact us](https://gitter.im/seleniumbase/SeleniumBase).
+
+The sbVirtualDisplay project will not tolerate harassment in sbVirtualDisplay's community, even outside of sbVirtualDisplay's public communication channels.
+
+## Questions
+
+It's always OK to ask questions.
+
+!["I try not to make fun of people for admitting they don't know things, because for each thing 'everyone knows' by the time they're adults, every day there are, on average, 10,000 people in the US hearing about it for the first time. If I make fun of people, I train them not to tell me when they have those moments. And I miss out on the fun." "Diet coke and mentos thing? What's that?" "Oh, man! We're going to the grocery store." "Why?" "You're one of today's lucky 10,000."](https://imgs.xkcd.com/comics/ten_thousand.png)
+
+Source: _[xkcd, May 2012](https://xkcd.com/1053/)_

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+## Bug Reports
+
+When opening a new issue or commenting on an existing issue, please make sure to provide concise, detailed instructions on how to reproduce the issue. If the issue can't be reproduced, it will be closed. Clearly describe the results you're seeing, and the results you're expecting.
+
+## (A Note on Style Guide Rules)
+
+[flake8](https://github.com/PyCQA/flake8) is the law of the land. The only flake8 rule ignored is [W503](https://github.com/grantmcconnaughey/Flake8Rules/blob/master/_rules/W503.md). For more details on why W503 should be ignored, see [this explanation](https://peps.python.org/pep-0008/#should-a-line-break-before-or-after-a-binary-operator), or [this shorter explanation](https://github.com/PyCQA/flake8/issues/494) by Python expert [Anthony Sottile](https://github.com/asottile).
+
+--------
+
+For questions about this document, reach out to [Michael Mintz](https://github.com/mdmintz).

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2021 Michael Mintz
+Copyright (c) 2014-2022 Michael Mintz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

SECURITY.md

@@ -0,0 +1,9 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you've found a security vulnerability in sbVirtualDisplay, (or a dependency we use), please open an issue.
+
+[github.com/mdmintz/sbVirtualDisplay/issues](https://github.com/mdmintz/sbVirtualDisplay/issues)
+
+Please describe the results you're seeing, and the results you're expecting.

sbvirtualdisplay/__version__.py

@@ -1,2 +1,2 @@
 # sbvirtualdisplay package
-__version__ = "1.0.0"
+__version__ = "1.1.0"

setup.cfg

@@ -0,0 +1,14 @@
+[flake8]
+# W503 (line break before binary operator) can be ignored.
+exclude=recordings,temp
+ignore=W503
+
+[nosetests]
+# nocapture=1 (Display print statements from output)
+#             (Undo this by using: "--nologcapture")
+# logging-level=INFO (Shorter logs than using DEBUG)
+nocapture=1
+logging-level=INFO
+
+[bdist_wheel]
+universal=1

setup.py

@@ -24,9 +24,9 @@
     long_description = "A customized pyvirtualdisplay for SeleniumBase."
 about = {}
 # Get the package version from the sbvirtualdisplay/__version__.py file
-with open(os.path.join(
-    this_dir, "sbvirtualdisplay", "__version__.py"
-), "rb") as f:
+with open(
+    os.path.join(this_dir, "sbvirtualdisplay", "__version__.py"), "rb"
+) as f:
     exec(f.read().decode("utf-8"), about)
 
 if sys.argv[-1] == "publish":
@@ -38,21 +38,24 @@
     reply = str(input_method(confirm_text)).lower().strip()
     if reply == "yes":
         print("\n*** Checking code health with flake8:\n")
-        os.system("python -m pip install 'flake8==3.9.2'")
+        os.system("python -m pip install 'flake8==4.0.1'")
         flake8_status = os.system("flake8 --exclude=temp")
         if flake8_status != 0:
             print("\nWARNING! Fix flake8 issues before publishing to PyPI!\n")
             sys.exit()
         else:
             print("*** No flake8 issues detected. Continuing...")
-        print("\n*** Rebuilding distribution packages: ***\n")
+        print("\n*** Removing existing distribution packages: ***\n")
         os.system("rm -f dist/*.egg; rm -f dist/*.tar.gz; rm -f dist/*.whl")
         os.system("rm -rf build/bdist.*; rm -rf build/lib")
-        os.system("python setup.py sdist bdist_wheel")  # Create new tar/wheel
+        print("\n*** Installing build: *** (Required for PyPI uploads)\n")
+        os.system("python -m pip install --upgrade 'build>=0.7.0'")
         print("\n*** Installing twine: *** (Required for PyPI uploads)\n")
-        os.system("python -m pip install --upgrade 'twine>=1.15.0'")
+        os.system("python -m pip install --upgrade 'twine>=4.0.0'")
         print("\n*** Installing tqdm: *** (Required for PyPI uploads)\n")
-        os.system("python -m pip install --upgrade 'tqdm>=4.61.2'")
+        os.system("python -m pip install --upgrade 'tqdm>=4.64.0'")
+        print("\n*** Rebuilding distribution packages: ***\n")
+        os.system("python -m build")  # Create new tar/wheel
         print("\n*** Publishing The Release to PyPI: ***\n")
         os.system("python -m twine upload dist/*")  # Requires ~/.pypirc Keys
         print("\n*** The Release was PUBLISHED SUCCESSFULLY to PyPI! :) ***\n")
@@ -111,28 +114,35 @@
         "Topic :: Utilities",
     ],
     python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
-    install_requires=[
-    ],
+    install_requires=[],
     extras_require={
         # pip install -e .[coverage]
+        # Usage: coverage run -m pytest; coverage html; coverage report
         "coverage": [
-            "coverage==5.5",
-            "pytest-cov==2.12.1",
+            'coverage==5.5;python_version<"3.6"',
+            'coverage==6.2;python_version>="3.6" and python_version<"3.7"',
+            'coverage==6.3.2;python_version>="3.7"',
+            'pytest-cov==2.12.1;python_version<"3.6"',
+            'pytest-cov==3.0.0;python_version>="3.6"',
         ],
         # pip install -e .[flake]
+        # Usage: flake8
         "flake": [
             'flake8==3.7.9;python_version<"3.5"',
-            'flake8==3.9.2;python_version>="3.5"',
+            'flake8==3.9.2;python_version>="3.5" and python_version<"3.6"',
+            'flake8==4.0.1;python_version>="3.6"',
+            "mccabe==0.6.1",
             'pyflakes==2.1.1;python_version<"3.5"',
-            'pyflakes==2.3.1;python_version>="3.5"',
+            'pyflakes==2.3.1;python_version>="3.5" and python_version<"3.6"',
+            'pyflakes==2.4.0;python_version>="3.6"',
             'pycodestyle==2.5.0;python_version<"3.5"',
-            'pycodestyle==2.7.0;python_version>="3.5"',
+            'pycodestyle==2.7.0;python_version>="3.5" and python_version<"3.6"',  # noqa: E501
+            'pycodestyle==2.8.0;python_version>="3.6"',
         ],
     },
     packages=[
         "sbvirtualdisplay",
     ],
     include_package_data=True,
-    entry_points={
-    },
+    entry_points={},
 )