Merge pull request #2 from ojarva/misc-modernization

Misc modernization

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,67 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '17 4 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/python-publish.yml

@@ -0,0 +1,32 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.github/workflows/python-tests.yml

@@ -0,0 +1,36 @@
+name: Run python tests
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pycodestyle isort pylint yapf
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Check pycodestyle
+      run: |
+        pycodestyle --ignore E501,E402 --exclude=.git,dev3 openvpn_status_parser tests
+    - name: Run pylint
+      run: |
+        pylint openvpn_status_parser tests
+    - name: Run tests
+      run: |
+        python3 setup.py test
+    - name: Check formatting
+      run: |
+        isort openvpn_status_parser tests; yapf --recursive -i .
+        git diff --exit-code  # This fails if isort&yapf combo made any changes

.pylintrc

@@ -0,0 +1,5 @@
+[format]
+max-line-length=125
+
+[messages control]
+disable=line-too-long,missing-docstring,no-self-use,fixme,bad-indentation,bad-continuation,invalid-name,too-many-locals,duplicate-code,too-many-branches,wrong-import-order

.style.yapf

@@ -0,0 +1,10 @@
+[style]
+based_on_style = pep8
+allow_split_before_dict_value = false
+blank_line_before_nested_class_or_def = false
+coalesce_brackets = true
+column_limit = 125
+dedent_closing_brackets = true
+each_dict_entry_on_separate_line = true
+join_multiple_lines = true
+spaces_around_power_operator = true

LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License:
+
+Copyright (C) 2012-2016, Olli Jarva <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.rst

@@ -34,26 +34,7 @@ Or using Python:
   pprint.pprint(parser.routing_table)
   pprint.pprint(parser.details)
 
+License
+-------
 
-MIT License:
-
-Copyright (C) 2012-2016, Olli Jarva \<[email protected]\>
-
-Permission is hereby granted, free of charge, to any person obtaining a
-copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be included
-in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+MIT License; see LICENSE.txt for full details.

openvpn_status_parser/__init__.py

@@ -29,18 +29,18 @@
 import datetime
 import logging
 import sys
+
 from . import exceptions
 
 
-class OpenVPNStatusParser(object):
+class OpenVPNStatusParser:
     """
     Usage:
 
     import pprint
     parser = OpenVPNStatusParser(filename)
     pprint.pprint(parser.connected_clients)
     """
-
     def __init__(self, filename):
         self.filename = filename
         self._connected_clients = None
@@ -59,55 +59,54 @@ def __init__(self, filename):
     def _process_title(self, row):
         try:
             self._details["title"] = row[1]
-        except IndexError:
+        except IndexError as err:
             logging.error("TITLE row is invalid: %s", row)
-            raise exceptions.MalformedFileException("TITLE row is invalid")
+            raise exceptions.MalformedFileException("TITLE row is invalid") from err
 
     def _process_time(self, row):
         try:
             self._details["timestamp"] = datetime.datetime.fromtimestamp(int(row[2]))
-        except (IndexError, ValueError):
+        except (IndexError, ValueError) as err:
             logging.error("TIME row is invalid: %s", row)
-            raise exceptions.MalformedFileException("TIME row is invalid")
+            raise exceptions.MalformedFileException("TIME row is invalid") from err
 
     def _process_header(self, row):
         try:
             self.topics_for[row[1]] = row[2:]
-        except IndexError:
+        except IndexError as err:
             logging.error("HEADER row is invalid: %s", row)
-            raise exceptions.MalformedFileException("HEADER row is invalid")
+            raise exceptions.MalformedFileException("HEADER row is invalid") from err
 
     def _process_client_list(self, row):
         try:
             self._connected_clients[row[1]] = dict(zip(self.topics_for["CLIENT_LIST"], row[1:]))
-            self._connected_clients[row[1]]["connected_since"] = (
-                datetime.datetime.fromtimestamp(int(row[-1])))
-        except IndexError:
+            self._connected_clients[row[1]]["connected_since"] = (datetime.datetime.fromtimestamp(int(row[-1])))
+        except IndexError as err:
             logging.error("CLIENT_LIST row is invalid: %s", row)
-            raise exceptions.MalformedFileException("CLIENT_LIST row is invalid")
-        except KeyError:
-            raise exceptions.MalformedFileException("Topics for CLIENT_LIST are missing")
+            raise exceptions.MalformedFileException("CLIENT_LIST row is invalid") from err
+        except KeyError as err:
+            raise exceptions.MalformedFileException("Topics for CLIENT_LIST are missing") from err
 
     def _process_routing_table(self, row):
         if len(row[1:]) != len(self.topics_for.get("ROUTING_TABLE", [])):
             raise exceptions.MalformedFileException("Invalid number of topics for ROUTING_TABLE row")
         try:
             self._routing_table[row[2]] = dict(zip(self.topics_for["ROUTING_TABLE"], row[1:]))
             self._routing_table[row[2]]["last_ref"] = datetime.datetime.fromtimestamp(int(row[-1]))
-        except IndexError:
+        except IndexError as err:
             logging.error("ROUTING_TABLE row is invalid: %s", row)
-            raise exceptions.MalformedFileException("ROUTING_TABLE row is invalid")
-        except ValueError:
-            raise exceptions.MalformedFileException("Invalid timestamp")
-        except KeyError:
-            raise exceptions.MalformedFileException("Topics for ROUTING_TABLE are missing")
+            raise exceptions.MalformedFileException("ROUTING_TABLE row is invalid") from err
+        except ValueError as err:
+            raise exceptions.MalformedFileException("Invalid timestamp") from err
+        except KeyError as err:
+            raise exceptions.MalformedFileException("Topics for ROUTING_TABLE are missing") from err
 
     def _process_global_stats(self, row):
         try:
             self._details[row[1]] = row[2]
-        except IndexError:
+        except IndexError as err:
             logging.error("GLOBAL_STATS row is invalid: %s", row)
-            raise exceptions.MalformedFileException("GLOBAL_STATS row is invalid")
+            raise exceptions.MalformedFileException("GLOBAL_STATS row is invalid") from err
 
     def _parse_file(self):
         self._details = {}
@@ -122,9 +121,8 @@ def _parse_file(self):
             elif row_title == "END":
                 return True
             else:
-                logging.warning("Line was not parsed. Keyword %s not recognized. %s",
-                                row_title, row)
-                raise exceptions.MalformedFileException("Unhandled keyword %s", row_title)
+                logging.warning("Line was not parsed. Keyword %s not recognized. %s", row_title, row)
+                raise exceptions.MalformedFileException(f"Unhandled keyword {row_title}")
 
         logging.error("File was incomplete. END line was missing.")
         raise exceptions.MalformedFileException("END line was missing.")

openvpn_status_parser/openvpn-status-parser

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-
 """OpenVPN status parser
 
 Usage:
@@ -12,6 +11,7 @@ import pprint
 import sys
 
 import docopt
+
 import openvpn_status_parser
 
 

setup.py

@@ -1,7 +1,8 @@
-from setuptools import setup, find_packages
 from codecs import open
 from os import path
 
+from setuptools import find_packages, setup
+
 here = path.abspath(path.dirname(__file__))
 
 with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
@@ -15,29 +16,26 @@
     url='https://github.com/ojarva/openvpn-status-parser',
     author='Olli Jarva',
     author_email='[email protected]',
-    license='BSD',
-
+    license='MIT',
     classifiers=[
         'Development Status :: 4 - Beta',
-
         'Intended Audience :: Developers',
         'License :: OSI Approved :: MIT License',
-
-        'Programming Language :: Python :: 2.6',
-        'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.2',
         'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: Implementation :: PyPy',
     ],
     keywords='openvpn',
     packages=["openvpn_status_parser"],
     install_requires=["docopt>=0.6.2"],
     test_suite="tests",
     scripts=["openvpn_status_parser/openvpn-status-parser"],
-
     extras_require={
         'dev': ['twine', 'wheel'],
     },