Merge 062421

.github/workflows/preflight_check.yaml

@@ -0,0 +1,76 @@
+name: Preflight Check
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  lint:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install black isort flake8
+    - name: Format checker with psf/black
+      uses: psf/black@stable
+      with:
+        options: "--check -l 79 --exclude docs/"
+        version: "24.3.0"
+    - name: Format checker with isort
+      run: isort --check-only -m 3 -l 79 --profile=black .
+    - name: Lint with flake8
+      run: flake8 --exclude test,docs,examples .
+  test:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Setup Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Setup Environment
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest pytest-cov defusedxml
+        pip install coveralls
+        sudo apt-get install -y nmap
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Test with pytest
+      run: |
+        pytest --cov=libnmap/ --ignore=libnmap/test/test_backend_plugin_factory.py
+    - name: Upload Coverage
+      if: matrix.python-version != '2.7'
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        COVERALLS_FLAG_NAME: ${{ matrix.python-version }}
+        COVERALLS_PARALLEL: true
+      run: |
+        coveralls --service=github
+  coveralls:
+    name: Finish Coveralls
+    needs: test
+    runs-on: ubuntu-22.04
+    container: python:3-slim
+    steps:
+    - name: Finished
+      run: |
+        pip3 install --upgrade coveralls
+        coveralls --finish --service=github
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pypi_publish.yaml

@@ -0,0 +1,26 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+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 setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist
+        twine upload dist/*

.gitignore

@@ -1,5 +1,6 @@
 *.py[cod]
 *.swp
+.pylintrc
 *~
 *.lock
 *.DS_Store
@@ -41,3 +42,6 @@ nosetests.xml
 .swp
 
 __pycache__
+.vscode/settings.json
+.noseids
+_build

.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+exclude: ^(test/|.tox/|docs)
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v2.3.0
+  hooks:
+  - id: check-yaml
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/psf/black
+  rev: 24.3.0
+  hooks:
+  - id: black
+    args: [--line-length=79]
+    files: ^libnmap
+- repo: https://github.com/pre-commit/mirrors-isort
+  rev: v5.6.4
+  hooks:
+  - id: isort
+    args: [--multi-line=3, --line-length=79, --profile=black]
+- repo: https://gitlab.com/pycqa/flake8
+  rev: 3.8.4
+  hooks:
+  - id: flake8
+    exclude: ^libnmap/(test/|docs/|examples/)
+- repo: local
+  hooks:
+  - id: pytest-check
+    name: pytest-check
+    stages: [pre-commit]
+    types: [python]
+    entry: pytest --cov=libnmap/ --ignore=libnmap/test/test_backend_plugin_factory.py
+    language: system
+    pass_filenames: false
+    always_run: true