CD and documentation

.github/workflows/test-and-publish.yaml.disabled → .github/workflows/test-and-publish.yaml

@@ -17,36 +17,34 @@ permissions:
   contents: read
 
 jobs:
-  test-package:
-    name: Run unittests
-    runs-on: windows-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+#   test-package:
+#     name: Run unittests
+#     runs-on: windows-latest
+#     strategy:
+#       fail-fast: false
+#       matrix:
+#         python-version: ["3.7", "3.8", "3.9", "3.10"]
 
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install pytest
-        if (Test-Path requirements.txt) { pip install -r requirements.txt }        
-# if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Test with pytest
-      run: |
-        pytest
+#     steps:
+#     - uses: actions/checkout@v3
+#     - name: Set up Python ${{ matrix.python-version }}
+#       uses: actions/setup-python@v3
+#       with:
+#         python-version: ${{ matrix.python-version }}
+#     - name: Install dependencies
+#       run: |
+#         python -m pip install --upgrade pip
+#         python -m pip install pytest
+#         if (Test-Path requirements.txt) { pip install -r requirements.txt }        
+# # if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+#     - name: Test with pytest
+#       run: |
+#         pytest
 
   deploy-package:
     name: Build and publish to PyPI
-    needs: test-package
+    # needs: test-package
     runs-on: ubuntu-latest
-
-
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python

README.md

@@ -70,6 +70,11 @@ Can be packaged to an EXE on windows with:
 The wifipasswords_exe.py file is the same as the __main__.py file in the package except will pause after console output is finished to prevent the terminal from auto-closing if the EXE is run directly.
 
 
+Testing
+-------
+Test locally with `pytest -v ./tests`
+Currently github test runners do not have nmcli interface to access wifi data so test locally. 
+
 About
 -----
 Creation date: 10-02-2019  

setup.py

@@ -3,9 +3,6 @@
 with open("README.md", "r", encoding="utf-8") as fh:
     long_description = fh.read()
 
-with open("requirements.txt", "r") as f:
-    required = f.read().splitlines()
-
 with open("wifipasswords/__init__.py", "r") as f:
     for line in f:
         if line.startswith("__version__"):
@@ -34,7 +31,7 @@
         "Topic :: System :: Networking",
     ],
     packages=["wifipasswords"],
-    install_requires=required,
+    install_requires=["colorama>=0.4.4"],
     licence="GPLv3",
     keywords=["wifipasswords", "passwords", "wifi", "networks", "dns", "wpasupplicant"],
     python_requires=">=3.6",