Merge pull request #1 from LimberDuck/develop

v0.0.1

.github/workflows/python-package.yml

@@ -0,0 +1,41 @@
+name: Python package
+
+on: [push]
+
+env:
+  python_package_name: tnscm
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: [3.7, 3.8, 3.9]
+
+    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 tools
+        run: |
+          python -m pip install --upgrade pip build setuptools wheel twine
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+      - name: Build package
+        run: |
+          python setup.py sdist bdist_wheel
+      - name: Install locally
+        run: |
+          ls
+          ls dist
+          TOOL_CURRENT_VERSION=`sed -e 's/.*__version__ = "\(.*\)".*/\1/' ${{ env.python_package_name }}/_version.py`
+          pip install dist/${{ env.python_package_name }}-${TOOL_CURRENT_VERSION}-py3-none-any.whl
+        shell: bash
+      - name: pip show package
+        run: |
+          pip show ${{ env.python_package_name }}

.github/workflows/python-publish.yml

@@ -0,0 +1,36 @@
+# 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
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+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 build setuptools wheel twine
+    - name: Build package
+      run: python setup.py sdist bdist_wheel
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -0,0 +1,7 @@
+build
+dist
+.idea
+.DS_Store
+*.egg-info
+__pycache__
+*.pyc

CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to [**TNSCM** *(Tenable Nessus CLI Manager)* by LimberDuck][1] project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [0.0.1] - 2021-08-24
+
+- initial release
+
+
+[0.0.1]: https://github.com/LimberDuck/tnscm/releases/tag/v0.0.1
+
+[1]: https://github.com/LimberDuck/tnscm

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Tenable, Inc.
+
+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.md

@@ -1 +1,54 @@
-# tnscm
+# TNSCM
+
+**TNSCM** *(Tenable Nessus CLI Manager)* by LimberDuck is a CLI tool which enables you to perform certain actions on Nessus by (C) Tenable, Inc. via Nessus API.
+
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/tnscm?logo=PyPI)](https://pypi.org/project/tnscm/) [![License](https://img.shields.io/github/license/LimberDuck/tnscm.svg)](https://github.com/LimberDuck/tnscm/blob/main/LICENSE) [![Repo size](https://img.shields.io/github/repo-size/LimberDuck/tnscm.svg)](https://github.com/LimberDuck/tnscm) [![Code size](https://img.shields.io/github/languages/code-size/LimberDuck/tnscm.svg)](https://github.com/LimberDuck/tnscm) [![Supported platform](https://img.shields.io/badge/platform-windows%20%7C%20macos%20%7C%20linux-lightgrey.svg)](https://github.com/LimberDuck/tnscm)
+
+
+Main features
+=============
+
+Initial version of **TNSCM** lets you get Nessus:
+* scans list
+* policies list
+* users list
+* status of available IPs
+
+
+How to
+======
+
+1. Install
+
+    `pip install tnscm`
+
+2. Run
+
+    `tnscm`
+
+Meta
+====
+
+Change log
+----------
+
+See [CHANGELOG].
+
+
+Licence
+-------
+
+MIT: [LICENSE].
+
+
+Authors
+-------
+
+[Damian Krawczyk] created **TNSCM** *(Tenable Nessus CLI Manager)* by LimberDuck.
+
+[Damian Krawczyk]: https://damiankrawczyk.com
+
+[CHANGELOG]: https://github.com/LimberDuck/tnscm/blob/main/CHANGELOG.md
+[LICENSE]: https://github.com/LimberDuck/tnscm/blob/main/LICENSE
+
+

requirements.txt

@@ -0,0 +1,7 @@
+certstore>=0.0.2
+click>=8.0.1
+keyring>=23.0.1
+oauthlib>=3.1.1
+requests>=2.25.1
+pandas>=1.3.2
+tabulate>=0.8.9

setup.py

@@ -0,0 +1,38 @@
+import setuptools
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+with open('requirements.txt') as f:
+    required = f.read().splitlines()
+
+about = {}
+with open("tnscm/_version.py") as f:
+    exec(f.read(), about)
+
+setuptools.setup(
+    name="tnscm",
+    version=about["__version__"],
+    author="Damian Krawczyk",
+    author_email="[email protected]",
+    description="TNSCM (Tenable Nessus CLI Manager) by LimberDuck",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/LimberDuck/tnscm",
+    packages=setuptools.find_packages(),
+    install_requires=required,
+    entry_points={
+        "console_scripts": [
+            "tnscm = tnscm.__main__:main"
+        ]
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.7",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Development Status :: 4 - Beta",
+        "Environment :: Console",
+    ],
+)

tnscm/__init__.py

@@ -0,0 +1 @@
+from tnscm._version import __version__