chore: update docs & branding, push requirements

Author: joni1993

Diff for: AUTHORS.rst

@@ -5,9 +5,14 @@ Credits
 Development Lead
 ----------------
 
-* Ralph Offinger <[email protected]>
+* Christian Jonak-Möchel <[email protected]>
 
 Contributors
 ------------
 
 * Thomas Fischer <[email protected]>
+
+Special Thanks
+-------------
+
+* Ralph Offinger <[email protected]> - For starting this project and having done most of the work

Diff for: CONTRIBUTING.rst

@@ -13,7 +13,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/ralph-hm/nagios_check_paloalto/issues.
+Report bugs at https://github.com/TeraIT-at/check_paloalto_ng/issues.
 
 If you are reporting a bug, please include:
 
@@ -36,14 +36,14 @@ is open to whoever wants to implement it.
 Write Documentation
 ~~~~~~~~~~~~~~~~~~~
 
-nagios_check_paloalto could always use more documentation, whether as part of the
-official nagios_check_paloalto docs, in docstrings, or even on the web in blog posts,
+check_paloalto_ng could always use more documentation, whether as part of the
+official check_paloalto_ng docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/ralph-hm/nagios_check_paloalto/issues.
+The best way to send feedback is to file an issue at https://github.com/TeraIT-at/check_paloalto_ng/issues.
 
 If you are proposing a feature:
 
@@ -55,17 +55,17 @@ If you are proposing a feature:
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `nagios_check_paloalto` for local development.
+Ready to contribute? Here's how to set up `check_paloalto_ng` for local development.
 
-1. Fork the `nagios_check_paloalto` repo on GitHub.
+1. Fork the `check_paloalto_ng` repo on GitHub.
 2. Clone your fork locally::
 
-    $ git clone [email protected]:your_name_here/nagios_check_paloalto.git
+    $ git clone [email protected]:your_name_here/check_paloalto_ng.git
 
 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
 
-    $ mkvirtualenv nagios_check_paloalto
-    $ cd nagios_check_paloalto/
+    $ mkvirtualenv check_paloalto_ng
+    $ cd check_paloalto_ng
     $ python setup.py develop
 
 4. Create a branch for local development::
@@ -104,6 +104,3 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
-3. The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check
-   https://travis-ci.org/ralph-hm/nagios_check_paloalto/pull_requests
-   and make sure that the tests pass for all supported Python versions.

Diff for: README.rst

@@ -1,59 +1,53 @@
 =============================================
-nagios_check_paloalto: a Nagios/Icinga Plugin
+check_paloalto_ng: a Nagios/Icinga Plugin
 =============================================
-nagios_check_paloalto is a **Nagios/Icinga plugin** for Palo Alto Next Generation Firewalls.
+check_paloalto_ng is a **Nagios/Icinga plugin** for Palo Alto Next Generation Firewalls, that was initially developed by ralpha089 (https://github.com/ralph089/nagios_check_paloalto)
 It is written in Python and based on the PA REST API.
 
+
 Tested on:
 
 - PA-500 v6.0.1 - v6.0.9
 - PA-3050 v6.0.9 - 7.1.9
 
-.. image:: https://travis-ci.org/ralph-hm/nagios_check_paloalto.svg?branch=master
-    :target: https://travis-ci.org/ralph-hm/nagios_check_paloalto?branch=master
-
-.. image:: https://coveralls.io/repos/github/ralph-hm/nagios_check_paloalto/badge.svg?branch=master
-    :target: https://coveralls.io/github/ralph-hm/nagios_check_paloalto?branch=master
-
-.. image:: https://badge.fury.io/py/check_paloalto.svg
-    :target: https://badge.fury.io/py/check_paloalto
 
 Documentation
 -------------
-http://nagios-check-paloalto.readthedocs.org/en/latest/
+https://check-paloalto-ng.readthedocs.io/en/latest/
 
 Quickstart
 ----------
 Please make sure you have python-dev and libxslt1-dev installed on your machine.
 
-To install nagios_check_paloalto::
+To install check_paloalto_ng::
 
-	$ pip install check_paloalto --upgrade
+	$ pip install check_paloalto_ng --upgrade
 
 or use::
 
-	$ pip3 install check_paloalto --upgrade
+	$ pip3 install check_paloalto_ng --upgrade
 
 The plugin requires a token to get information from the PA-REST-API. Please see the following link for more information:
-http://nagios-check-paloalto.readthedocs.org/en/latest/configuration.html#token
+https://check-paloalto-ng.readthedocs.io/en/latest//configuration.html#token
 
 Usage
 -----
 Command-line usage::
 
-    usage: check_paloalto [-h] -H HOST -T TOKEN [-v] [-t TIMEOUT] [--reset]
+    usage: check_paloalto_ng [-h] -H HOST -T TOKEN [-v] [-t TIMEOUT] [--reset]
                       [--version]
                       {diskspace,certificates,load,useragent,environmental,sessinfo,thermal,throughput}
                       ...
 
     positional arguments:
-      {diskspace,certificates,load,useragent,environmental,sessinfo,thermal,throughput}
+      {diskspace,certificates,load,useragent,environmental,powersupply,pppoe,sessinfo,thermal,throughput}
         diskspace           check used diskspace.
-        certificates        check the certificate store for expiring certificates:
-                            Outputs is a warning, if a certificate is in range.
+        certificates        check the certificate store for expiring certificates: Outputs is a warning, if a certificate is in range.
         load                check the CPU load.
         useragent           check for running useragents.
         environmental       check if an alarm is found.
+        powersupply         check present power supplies.
+        pppoe               check the pppoe interface.
         sessinfo            check important session parameters.
         thermal             check the temperature.
         throughput          check the throughput.

Diff for: docs/check_pa.modules.rst

@@ -28,6 +28,22 @@ check_pa.modules.environmental module
     :undoc-members:
     :show-inheritance:
 
+check_pa.modules.powersupply module
+-------------------------------------
+
+.. automodule:: check_pa.modules.powersupply
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+check_pa.modules.pppoe module
+-------------------------------------
+
+.. automodule:: check_pa.modules.pppoe
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 check_pa.modules.load module
 ----------------------------
 

Diff for: docs/conf.py

@@ -55,8 +55,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'nagios_check_paloalto'
-copyright = u'2015, Ralph Offinger'
+project = u'check_paloalto_ng'
+copyright = u'2022, Christian Jonak-Möchel'
 
 # The version info for the project you're documenting, acts as replacement
 # for |version| and |release|, also used in various other places throughout
@@ -209,8 +209,8 @@
 # [howto/manual]).
 latex_documents = [
     ('index', 'check_paloalto.tex',
-     u'nagios_check_paloalto Documentation',
-     u'Ralph Offinger', 'manual'),
+     u'check_paloalto_ng Documentation',
+     u'Christian Jonak-Möchel', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at
@@ -240,8 +240,8 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index', 'check_paloalto',
-     u'nagios_check_paloalto Documentation',
-     [u'Ralph Offinger'], 1)
+     u'check_paloalto_ng Documentation',
+     [u'Christian Jonak-Möchel'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -255,8 +255,8 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     ('index', 'check_paloalto',
-     u'nagios_check_paloalto Documentation',
-     u'Ralph Offinger',
+     u'check_paloalto_ng Documentation',
+     u'Christian Jonak-Möchel',
      'check_paloalto',
      'Checks PaloAlto Firewall Systems',
      'Miscellaneous'),

Diff for: docs/index.rst

@@ -1,4 +1,4 @@
-Welcome to nagios_check_paloalto's documentation!
+Welcome to check_paloalto_ng's documentation!
 ======================================
 
 Contents:

Diff for: docs/installation.rst

@@ -4,8 +4,8 @@ Installation
 
 Simply install check_paloalto::
 
-	$ pip install check_paloalto
+	$ pip install check_paloalto_ng
 
 or use::
 
-	$ pip3 install check_paloalto
+	$ pip3 install check_paloalto_ng

Diff for: docs/usage.rst

@@ -10,13 +10,14 @@ Command-line usage::
                       ...
 
     positional arguments:
-      {diskspace,certificates,load,useragent,environmental,sessinfo,thermal,throughput}
+      {diskspace,certificates,load,useragent,environmental,powersupply,pppoe,sessinfo,thermal,throughput}
         diskspace           check used diskspace.
-        certificates        check the certificate store for expiring certificates:
-                            Outputs is a warning, if a certificate is in range.
+        certificates        check the certificate store for expiring certificates: Outputs is a warning, if a certificate is in range.
         load                check the CPU load.
         useragent           check for running useragents.
         environmental       check if an alarm is found.
+        powersupply         check present power supplies.
+        pppoe               check the pppoe interface.
         sessinfo            check important session parameters.
         thermal             check the temperature.
         throughput          check the throughput.
@@ -108,6 +109,39 @@ example::
     $ check_paloalto -H HOST -T TOKEN environmental
     $ ENVIRONMENTAL OK - No alarms found.
 
+powersupply
+-------------
+usage::
+
+    usage: check_paloalto powersupply [-h] [-m MIN]
+
+    optional arguments:
+      -h, --help         show this help message and exit
+      -m MIN, --min MIN  Warning if functional PSU is lower than specified. (default: 1)
+
+example::
+
+    $ check_paloalto -H HOST -T TOKEN powersupply
+    $ POWERSUPPLY OK - 2 working power supplies. | 'Functional Power Supplies'=2;;@0 'Slot 1-Power Supply #1-Alarm'=0 'Slot 1-Power Supply #1-Inserted'=1 'Slot 1-Power Supply #2-Alarm'=0 'Slot 1-Power Supply #2-Inserted'=1
+
+pppoe
+-------------
+usage::
+
+    usage: check_paloalto pppoe [-h] -i [INTERFACE] [--expect-down] [-m MTU]
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      -i [INTERFACE], --interface [INTERFACE]
+                            PA interface name
+      --expect-down         Expect PPPOE session to be down. (default: False)
+      -m MTU, --mtu MTU     Minimum expected MTU (default: 1492)
+
+example::
+
+    $ check_paloalto -H HOST -T TOKEN pppoe -i ethernet1/1 
+    PPPOEINTERFACE OK - ethernet1/1: PPPoE is UP, PPP is UP, MTU is 1492 | 'ethernet1/1-pppoe-mtu'=1492;;1492 'ethernet1/1-pppoe-ppp-state'=1;;True 'ethernet1/1-pppoe-pppoe-state'=1;;True
+
 
 sessinfo
 --------

Diff for: requirements.txt

@@ -1,11 +1,30 @@
-mock==2.0.0
-pytest==2.9.1
-tox==2.3.1
-python-coveralls==2.7.0
-pytest-cov==2.2.1
-nagiosplugin==1.2.4
-beautifulsoup4==4.4.1
-lxml==3.6.0
-requests==2.10.0
-responses==0.5.1
-wheel==0.29.0
+attrs==21.4.0
+beautifulsoup4==4.11.1
+certifi==2021.10.8
+charset-normalizer==2.0.12
+coverage==6.3.2
+distlib==0.3.4
+filelock==3.6.0
+idna==3.3
+iniconfig==1.1.1
+lxml==4.8.0
+mock==4.0.3
+nagiosplugin==1.3.3
+packaging==21.3
+platformdirs==2.5.2
+pluggy==1.0.0
+py==1.11.0
+pyparsing==3.0.8
+pytest==7.1.2
+pytest-cov==3.0.0
+python-coveralls==2.9.3
+PyYAML==6.0
+requests==2.27.1
+responses==0.20.0
+six==1.16.0
+soupsieve==2.3.2.post1
+toml==0.10.2
+tomli==2.0.1
+tox==3.25.0
+urllib3==1.26.9
+virtualenv==20.14.1

Diff for: setup.py

@@ -22,14 +22,14 @@
     'flake8'
 ]
 
-setup(name='check_paloalto',
+setup(name='check_paloalto_ng',
       version='0.3.2',
-      description="check_paloalto is a Nagios/Icinga plugin for Palo Alto Next Generation Firewalls. It is written in "
+      description="check_paloalto_ng is a Nagios/Icinga plugin for Palo Alto Next Generation Firewalls. It is written in "
                   "Python and based on the PA REST API.",
       long_description=readme + '\n\n' + history,
-      author="Ralph Offinger",
-      author_email='[email protected]',
-      url='https://github.com/ralph-hm/nagios_check_paloalto',
+      author="Christian Jonak-Möchel",
+      author_email='[email protected]',
+      url='https://github.com/TeraIT-at/check_paloalto_ng',
       install_requires=requirements,
       packages=['check_pa', 'check_pa.modules'],
       entry_points={
@@ -44,12 +44,14 @@
           'Intended Audience :: System Administrators',
           'Topic :: System :: Monitoring',
           'License :: OSI Approved :: Common Public License',
-          'Programming Language :: Python :: 2',
-          'Programming Language :: Python :: 2.7',
           'Programming Language :: Python :: 3',
           '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 :: 3.9',
       ],
       keywords='paloalto icinga nagios check',
       zip_safe=False,

Diff for: tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py27, py33, py34, py35
+envlist = py33, py34, py35, py36, py37, py38, py39
 toxworkdir={homedir}
 
 [testenv]