more testing, docs, examples

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,36 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Your script
+2. What you're connecting to (vendor, platform, version)
+3. Anything else relevant
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Stack Trace**
+Copy of your stack trace here, please format it properly using triple back ticks (top left key on US keyboards!)
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**OS (please complete the following information):**
+ - OS: [e.g. Ubuntu, MacOS, etc. - Note this is *not* tested on Windows and likely will not be supported]
+ - nssh version
+ - ssh2python version
+ - paramiko version
+ - python version
+
+**Additional context**
+Add any other context about the problem here.

.github/workflows/commit.yaml

@@ -0,0 +1,26 @@
+name: linting and unit tests
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      max-parallel: 6
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: [3.6, 3.7, 3.8]
+    steps:
+      - uses: actions/checkout@v1
+      - name: set up python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: setup test env
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install setuptools
+          python -m pip install tox
+      - name: run tox
+        run: python -m tox --skip-missing-interpreters=true
+

.github/workflows/publish.yaml

@@ -0,0 +1,49 @@
+name: re-test and publish to pypi
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      max-parallel: 6
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: [3.6, 3.7, 3.8]
+    steps:
+      - uses: actions/checkout@v1
+      - name: set up python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: setup test env
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install setuptools
+          python -m pip install tox
+      - name: run tox
+        run: python -m tox --skip-missing-interpreters=true
+
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: set up python 3.8
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.8
+      - name: setup publish env
+        run: |
+            python -m pip install --upgrade pip
+            python -m pip install setuptools
+            python -m pip install wheel
+            python -m pip install twine
+      - name: build and publish
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USER }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASS }}
+        run: |
+          python setup.py sdist bdist_wheel
+          python -m twine upload dist/*

.github/workflows/weekly.yaml

@@ -0,0 +1,28 @@
+name: weekly linting and unit tests
+
+on:
+  schedule:
+    # weekly at 0700 PST/1400 UTC on Sunday
+    - cron: '0 14 * * 0'
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      max-parallel: 6
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: [3.6, 3.7, 3.8]
+    steps:
+      - uses: actions/checkout@v1
+      - name: set up python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: setup test env
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install setuptools
+          python -m pip install tox
+      - name: run tox
+        run: python -m tox --skip-missing-interpreters=true

.pylintrc

@@ -65,7 +65,7 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
-disable=C0103,C0115,C0330,W0105,W1202,W1203,R0902,R0913,W0511
+disable=C0103,C0115,C0330,W0105,W1202,W1203,R0902,R0913
 # C0103 = constant-name (a little too aggressive for some things that aren't "really" constants")
 # C0115 = class docstrings (init doc strings cover this already)
 # C0330 = bad-continuation (hanging indent that black doesnt like)
@@ -74,7 +74,6 @@ disable=C0103,C0115,C0330,W0105,W1202,W1203,R0902,R0913,W0511
 # W1203 = logging-fstring-interpolation (py3.6, using f-strings so dont care)
 # R0902 = too-many-instance-attributes
 # R0913 = too-many-arguments
-# W0511 -- TODO just for now...
 
 [REPORTS]