Applied various minor improvements

Author: dhondta

.github/workflows/pypi-publish.yml

@@ -19,7 +19,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
@@ -31,11 +31,12 @@ jobs:
     - name: Install ${{ env.package }}
       run: |
         python -m pip install --upgrade pip
-        python -m pip install pytest pytest-cov pytest-pythonpath coverage
+        python -m pip install pytest pytest-cov coverage
         pip install -r requirements.txt
         pip install .
     - name: Test ${{ env.package }} with pytest
       run: |
+        export PYTHONPATH=$PYTHONPATH:$(pwd)/../tests/
         pytest --cov=$package
   coverage:
     needs: build
@@ -47,18 +48,19 @@ jobs:
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
       with:
-        python-version: "3.10"
+        python-version: "3.12"
     - name: Install pandoc
       run: sudo apt-get install -y pandoc notification-daemon
     - name: Install ${{ env.package }}
       run: |
         python -m pip install --upgrade pip
-        python -m pip install pytest pytest-cov pytest-pythonpath
+        python -m pip install pytest pytest-cov
         pip install -r requirements.txt
         pip install .
     - name: Make coverage badge for ${{ env.package }}
       run: |
         pip install genbadge[coverage]
+        export PYTHONPATH=$PYTHONPATH:$(pwd)/../tests/
         pytest --cov=$package --cov-report=xml
         genbadge coverage -i coverage.xml -o $cov_badge_path
     - name: Verify Changed files
@@ -79,3 +81,33 @@ jobs:
       with:
         github_token: ${{ secrets.github_token }}
         branch: ${{ github.ref }}
+  deploy:
+    runs-on: ubuntu-latest
+    needs: coverage
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - name: Check for version change
+      uses: dorny/paths-filter@v2
+      id: filter
+      with:
+        filters: |
+          version:
+            - '**/VERSION.txt'
+    - if: steps.filter.outputs.version == 'true'
+      name: Cleanup README
+      run: |
+        sed -ri 's/^(##*)\s*:.*:\s*/\1 /g' README.md
+        awk '{if (match($0,"## Supporters")) exit; print}' README.md > README
+        mv -f README README.md
+    - if: steps.filter.outputs.version == 'true'
+      name: Build ${{ env.package }} package
+      run: python3 -m pip install --upgrade build && python3 -m build
+    - if: steps.filter.outputs.version == 'true'
+      name: Upload ${{ env.package }} to PyPi
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}
+        verbose: true
+        verify_metadata: false

.github/workflows/python-package.yml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=61.0", "setuptools-scm"]
+requires = ["setuptools>=80.0.0", "setuptools-scm"]
 build-backend = "setuptools.build_meta"
 
 [tool.pytest.ini_options]
@@ -33,10 +33,9 @@ classifiers = [
   "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 dependencies = [
-  "peewee>=3.17.6",
-  "prompt_toolkit>=3.0.47",
-  "requests",
-  "tinyscript>=1.30.15",
+  "peewee>=3.18.2",
+  "prompt_toolkit>=3.0.52",
+  "tinyscript>=1.30.28",
 ]
 dynamic = ["version"]
 

pyproject.toml

@@ -1,2 +1,2 @@
 [pytest]
-python_paths = src
+pythonpath = src

pytest.ini

@@ -1,4 +1,3 @@
-peewee>=3.17.6
-prompt_toolkit>=3.0.47
-requests
-tinyscript>=1.30.15
+peewee>=3.18.2
+prompt_toolkit>=3.0.52
+tinyscript>=1.30.28

requirements.txt

@@ -1 +1 @@
-0.6.0
+0.6.1

src/sploitkit/VERSION.txt

@@ -61,7 +61,7 @@ def run(self, text):
 class Show(Command):
     """ Show options, projects, modules or issues (if any) """
     level = "root"
-    keys = ["files", "modules", "options", "projects"]
+    keys = []
 
     def complete_values(self, key):
         if key == "files":
@@ -126,16 +126,25 @@ def run(self, key, value=None):
                 print_formatted_text(BorderlessTable(data, "Open sessions"))
 
     def set_keys(self):
+        if sum(1 for _ in self.console._files.list) > 0:
+            self.keys.append("files")
         if Entity.has_issues():
-            self.keys += ["issues"]
+            self.keys.append("issues")
         else:
             while "issues" in self.keys:
                 self.keys.remove("issues")
+        if len(self.console.modules) > 0:
+            self.keys.append("modules")
+        if sum(1 for _ in self.config.options()) > 0:
+            self.keys.append("options")
+        if len(projects(self)) > 0:
+            self.keys.append("projects")
         if len(self.console._sessions) > 0:
-            self.keys += ["sessions"]
+            self.keys.append("sessions")
         else:
             while "sessions" in self.keys:
                 self.keys.remove("sessions")
+        self.keys = list(set(self.keys))
 
     def validate(self, key, value=None):
         if key not in self.keys:

src/sploitkit/base/commands/general.py

@@ -1,5 +1,6 @@
 # -*- coding: UTF-8 -*-
-from tinyscript.helpers import confirm, Path, ProjectPath
+from prompt_toolkit.formatted_text import ANSI
+from tinyscript.helpers import confirm, BorderlessTable, Path, ProjectPath
 
 from sploitkit import *
 
@@ -118,5 +119,6 @@ class Show(Command):
     values = ["options"]
 
     def run(self, value):
-        print_formatted_text(BorderlessTable(self.console.__class__.options, "Console options"))
+        #print_formatted_text(BorderlessTable(self.config, "Console options"))
+        print_formatted_text(ANSI(str(self.config)))
 

src/sploitkit/base/commands/project.py

@@ -126,8 +126,6 @@ def run(self):
             if len(v) == 0:
                 continue
             if isinstance(v, Iterable):
-                if isinstance(v, dict):
-                    v = dict(**v)
                 for l in yaml.dump(v).split("\n"):
                     if len(l.strip()) == 0:
                         continue

src/sploitkit/base/commands/utils.py

@@ -1,5 +1,5 @@
 # -*- coding: UTF-8 -*-
-from peewee import SqliteDatabase
+from peewee import OperationalError, SqliteDatabase
 
 
 __all__ = ["StoragePool"]
@@ -40,9 +40,12 @@ def get(self, path, *args, **kwargs):
             self.__pool.append(db)
             for m in self.models:
                 m.bind(db)
-            db.create_tables(self.models, safe=True)
-            db.close()  # commit and save the created tables
-            db.connect()
+            try:
+                db.create_tables(self.models, safe=True)
+                db.close()  # commit and save the created tables
+                db.connect()
+            except OperationalError:
+                db._mode = "ro"
         return db
 
     def remove(self, db):
@@ -66,6 +69,7 @@ class Store(SqliteDatabase):
     def __init__(self, path, *args, **kwargs):
         self.path = str(path)  # ensure the input is str, e.g. not Path
         self._last_snapshot = 0
+        self._mode = "rw"
         kwargs.setdefault('pragmas', {})
         # enable automatic VACUUM (to regularly defragment the DB)
         kwargs['pragmas'].setdefault('auto_vacuum', 1)