Merge aa24f35 into 4e7c620

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,27 +7,34 @@ assignees: ''
 
 ---
 
-**Describe the bug**
+Describe the bug
+================
 A clear and concise description of what the bug is.
 
-**To Reproduce**
+To Reproduce
+------------
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
+Expected behavior
+-----------------
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
+Screenshots
+-----------
 If applicable, add screenshots to help explain your problem.
 
-**Computer (please complete the following information):**
- - OS: [e.g. iOS]
- - Python version [e.g. 3.6]
- - Compiler with version [e.g., gfortran 47]
- - Apexpy version/branch [e.g., 1.1.0]
+Computer
+--------
+Please provide the following information:
+  * OS: (e.g., iOS)
+  * Python version: (e.g., 3.6)
+  * Compiler with version: (e.g., gfortran 47)
+  * Apexpy version/branch: (e.g., 1.1.0/main)
 
-**Additional context**
+Additional context
+------------------
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -6,21 +6,32 @@ labels: 'enhancement'
 assignees: ''
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always
-frustrated when [...]
+Requested feature
+=================
+A short description of what you are proposing.
 
-**Describe the solution you'd like**
+The problem or gap this feature will address
+--------------------------------------------
+A clear and concise description of what the problem is. For example, I'm always
+frustrated when ...
+
+The desired solution
+--------------------
 A clear and concise description of what you want to happen.  Keep the scope as
 narrow as possible, to make it easier to implement
 
-**Describe alternatives you've considered**
+Possible alternatives
+---------------------
 A clear and concise description of any alternative solutions or features you've
 considered.
 
-**Additional context**
-Add any other context or screenshots about the feature request here.  For context, the apexpy version/branch you're working on, your system detail, your python version, and your compiler (with version) may or may not be relevant.
+Additional context
+------------------
+Add any other context or screenshots about the feature request here.  For
+context, the apexpy version/branch you're working on, your system detail, your
+python version, and your compiler (with version) may or may not be relevant.
 
-**Reminders**
+Reminders
+---------
 This is a volunteer-driven project.  Code contributions are welcome, as is help
 testing new code.

.github/ISSUE_TEMPLATE/question.md

@@ -7,27 +7,34 @@ assignees: ''
 
 ---
 
-**Describe the problem or ask the question**
+Describe the problem or ask the question
+========================================
 A clear and concise description of what the problem or question is.
 
-**Provide an example, if applicable**
+Provide an example, if applicable
+---------------------------------
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See behaviour
 
-**Expectations**
+Expectations
+------------
 A clear and concise description of what you expected (or wanted) to happen.
 
-**Screenshots**
+Screenshots
+-----------
 If applicable, add screenshots to help explain your question.
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Python version [e.g. 3.6]
- - Compiler with version [e.g., gfortran 22]
- - Apexpy version/branch [e.g., 1.1.0]
+Computer
+--------
+Please complete the following information:
+  * OS: (e.g., iOS)
+  * Python version: (e.g., 3.6)
+  * Compiler with version: (e.g., gfortran 22)
+  * Apexpy version/branch: (e.g., 1.1.0/main)
 
-**Additional context**
+Additional context
+------------------
 Add any other context about the problem here.

.github/pull_request_template.md

@@ -1,39 +1,38 @@
-# Description
+Description
+===========
 
 Please include a summary of the change and which issue is fixed. Please also
 include relevant motivation and context. List any dependencies that are required
 for this change.  Please see ``CONTRIBUTING.rst`` for more guidelines.
 
 Fixes # (issue)
 
-## Type of change
-
+Type of change
+--------------
 Please delete options that are not relevant.
 
-- Bug fix (non-breaking change which fixes an issue)
-- New feature (non-breaking change which adds functionality)
-- Breaking change (fix or feature that would cause existing functionality
-  to not work as expected)
-- This change requires a documentation update
-- Release candidate
-
-# How Has This Been Tested?
+  * Bug fix (non-breaking change which fixes an issue)
+  * New feature (non-breaking change which adds functionality)
+  * Breaking change (fix or feature that changes existing functionality)
+  * This change requires a documentation update
+  * Release candidate
 
+How Has This Been Tested?
+-------------------------
 Please describe the tests that you ran to verify your changes. Provide
-instructions so we can reproduce. Please also list any relevant details for
-your test configuration
-
-- Test A
-- Test B
+instructions so we can reproduce the desired behaviour.
 
-**Test Configuration**:
-* Operating system: (e.g., Hal)
-* Python version number: (e.g., 3.7)
-* Compiler with version number: (e.g. gfortran 9.0)
-* Any details about your local setup that are relevant (e.g., apexpy version/branch)
+  * Test A
+  * Test B
 
-# Checklist:
+### Test Configuration
+  * Operating system: (e.g., Hal)
+  * Python version number: (e.g., 3.7)
+  * Compiler with version number: (e.g. gfortran 9.0)
+  * Relevant local setup details: (e.g., apexpy version/branch)
 
+Checklist
+---------
 - [ ] Make sure you are merging into the ``develop`` (not ``main``) branch
 - [ ] My code follows the style guidelines of this project
 - [ ] I have performed a self-review of my own code

CHANGELOG.rst

@@ -6,6 +6,8 @@ Changelog
 ------------------
 * Removed Python 2 support
 * Updated community and package documentation
+* Updated unit test style to reduce duplication and better follow PEP8
+* Updated code style using codacy suggestions
 
 1.1.0 (2021-03-05)
 ------------------

CODE_OF_CONDUCT.md

@@ -5,9 +5,9 @@
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
+size, disability, ethnicity, sex characteristics, gender identity and
+expression, level of experience, education, socio-economic status, nationality,
+persona appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards
 
@@ -23,13 +23,13 @@ include:
 Examples of unacceptable behavior by participants include:
 
 * The use of sexualized language or imagery and unwelcome sexual attention or
- advances
+  advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic
- address, without explicit permission
+  address, without explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
- professional setting
+  professional setting
 
 ## Our Responsibilities
 
@@ -58,19 +58,21 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported by contacting the project team at angeline.burrell@nrl.navy.mil. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other
 members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
 For answers to common questions about this code of conduct, see
 https://www.contributor-covenant.org/faq
+
+[homepage]: https://www.contributor-covenant.org

ci/appveyor-bootstrap.py

@@ -1,10 +1,12 @@
 """
-AppVeyor will at least have few Pythons around so there's no point of implementing a bootstrapper in PowerShell.
+AppVeyor will at least have few Pythons around so there's no point of
+implementing a bootstrapper in PowerShell.
 
-This is a port of https://github.com/pypa/python-packaging-user-guide/blob/master/source/code/install.ps1
-with various fixes and improvements that just weren't feasible to implement in PowerShell.
+This is a port of https://github.com/pypa/python-packaging-user-guide/blob/
+master/source/code/install.ps1 with various fixes and improvements that just
+weren't feasible to implement in PowerShell.
 """
-from __future__ import print_function
+
 from os import environ
 from os.path import exists
 from subprocess import check_call
@@ -16,30 +18,38 @@
 
 BASE_URL = "https://www.python.org/ftp/python/"
 GET_PIP_URL = "https://bootstrap.pypa.io/get-pip.py"
-GET_PIP_PATH = "C:\get-pip.py"
+GET_PIP_PATH = r"C:\get-pip.py"
+
+# These URLS No longer seem to be needed, but are kept here for reference
+# NOTE: no .msi installer for 3.3.6
 URLS = {
     ("2.6", "64"): BASE_URL + "2.6.6/python-2.6.6.amd64.msi",
     ("2.6", "32"): BASE_URL + "2.6.6/python-2.6.6.msi",
     ("2.7", "64"): BASE_URL + "2.7.10/python-2.7.10.amd64.msi",
     ("2.7", "32"): BASE_URL + "2.7.10/python-2.7.10.msi",
-    # NOTE: no .msi installer for 3.3.6
     ("3.3", "64"): BASE_URL + "3.3.3/python-3.3.3.amd64.msi",
     ("3.3", "32"): BASE_URL + "3.3.3/python-3.3.3.msi",
     ("3.4", "64"): BASE_URL + "3.4.3/python-3.4.3.amd64.msi",
     ("3.4", "32"): BASE_URL + "3.4.3/python-3.4.3.msi",
     ("3.5", "64"): BASE_URL + "3.5.0/python-3.5.0-amd64.exe",
     ("3.5", "32"): BASE_URL + "3.5.0/python-3.5.0.exe",
 }
+
+# Commands are allowed to fail only if they are not the last command.
+# E.G., uninstall (/x) allowed to fail.
 INSTALL_CMD = {
-    # Commands are allowed to fail only if they are not the last command.  Eg: uninstall (/x) allowed to fail.
     "2.6": [["msiexec.exe", "/L*+!", "install.log", "/qn", "/x", "{path}"],
-            ["msiexec.exe", "/L*+!", "install.log", "/qn", "/i", "{path}", "TARGETDIR={home}"]],
+            ["msiexec.exe", "/L*+!", "install.log", "/qn", "/i", "{path}",
+             "TARGETDIR={home}"]],
     "2.7": [["msiexec.exe", "/L*+!", "install.log", "/qn", "/x", "{path}"],
-            ["msiexec.exe", "/L*+!", "install.log", "/qn", "/i", "{path}", "TARGETDIR={home}"]],
+            ["msiexec.exe", "/L*+!", "install.log", "/qn", "/i", "{path}",
+             "TARGETDIR={home}"]],
     "3.3": [["msiexec.exe", "/L*+!", "install.log", "/qn", "/x", "{path}"],
-            ["msiexec.exe", "/L*+!", "install.log", "/qn", "/i", "{path}", "TARGETDIR={home}"]],
+            ["msiexec.exe", "/L*+!", "install.log", "/qn", "/i", "{path}",
+             "TARGETDIR={home}"]],
     "3.4": [["msiexec.exe", "/L*+!", "install.log", "/qn", "/x", "{path}"],
-            ["msiexec.exe", "/L*+!", "install.log", "/qn", "/i", "{path}", "TARGETDIR={home}"]],
+            ["msiexec.exe", "/L*+!", "install.log", "/qn", "/i", "{path}",
+             "TARGETDIR={home}"]],
     "3.5": [["{path}", "/quiet", "TargetDir={home}"]],
 }
 
@@ -59,7 +69,8 @@ def report(count, size, total):
 
 
 def install_python(version, arch, home):
-    print("Installing Python", version, "for", arch, "bit architecture to", home)
+    print("Installing Python", version, "for", arch,
+          "bit architecture to", home)
     if exists(home):
         return
 
@@ -112,6 +123,8 @@ def install_packages(home, *packages):
 
 
 if __name__ == "__main__":
-    install_python(environ['PYTHON_VERSION'], environ['PYTHON_ARCH'], environ['PYTHON_HOME'])
+    install_python(environ['PYTHON_VERSION'], environ['PYTHON_ARCH'],
+                   environ['PYTHON_HOME'])
     install_pip(environ['PYTHON_HOME'])
-    install_packages(environ['PYTHON_HOME'], "setuptools>=18.0.1", "wheel", "tox", "virtualenv>=13.1.0")
+    install_packages(environ['PYTHON_HOME'], "setuptools>=18.0.1", "wheel",
+                     "tox", "virtualenv>=13.1.0")