version 1.6.5 - see change log for changes and updates

Author: nocomplexity

CHANGELOG.md

@@ -1,5 +1,30 @@
 # Change Log
 
+## Version 1.6.5:
+
+
+**Added:**
+
+* **Plain FTP Validation:** Introduced a new validation check to detect the use of plain FTP. Using FTP in modern Python applications is considered a significant security risk (red flag).
+
+**Changed:**
+
+* **Version Retrieval:** Reverted the change that retrieved package versions from PyPI (originally introduced in PR #16) due to compatibility issues with WASM.
+* **CI/CD Configuration:** Updated `pyproject.toml` to enhance GitHub Actions testing workflows. (Credit: @jurgenwigg)
+
+**Fixed:**
+
+* **Docstring Improvements:** Enhanced and refined docstrings across the Altair APIs for better clarity and developer experience.
+
+**Documentation:**
+
+* **Manual Update:** Substantial improvements to the user manual, including a new section dedicated to integrating and using Python security validation tools.
+
+## Version 1.6.4:
+
+Fixed:
+- Dashboard Reporting: Resolved issue affecting dashboard rendering and data output within the Panel / WASM (WebAssembly) environment.
+
 
 ## Version 1.6.3:
 

docs/CLIcommands.ipynb

@@ -13,17 +13,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 1,
    "id": "923aba22-7103-4431-8545-ee5596efa371",
    "metadata": {},
    "outputs": [],
    "source": [
-    "from codeaudit import codeaudit"
+    "from codeaudit import corecli"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 2,
    "id": "057c9730-7b09-49a8-82f1-bc681d880c96",
    "metadata": {},
    "outputs": [],
@@ -33,18 +33,18 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 3,
    "id": "67576531-b66f-42a3-b6e4-460423ca28e0",
    "metadata": {},
    "outputs": [],
    "source": [
     "%%capture version --no-display\n",
-    "codeaudit.display_version()"
+    "corecli.display_version()"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": 4,
    "id": "2717fe66-9e66-4fcc-ae82-0d1ba26892c4",
    "metadata": {},
    "outputs": [],
@@ -54,7 +54,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 5,
    "id": "3f286724-0a8f-45b2-80fe-d6d061fe440a",
    "metadata": {},
    "outputs": [],
@@ -66,18 +66,18 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 14,
+   "execution_count": 6,
    "id": "693c3354-530b-4a40-a561-ed722d9bb1fa",
    "metadata": {},
    "outputs": [],
    "source": [
     "%%capture helpoutput --no-display\n",
-    "codeaudit.display_help()"
+    "corecli.display_help()"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": 7,
    "id": "5fa9a420-bd9a-4641-99c9-de0bcf448dbc",
    "metadata": {},
    "outputs": [],
@@ -90,7 +90,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 8,
    "id": "bf6afe56-e0f7-4fa2-a3a5-968bad11bf9c",
    "metadata": {},
    "outputs": [],
@@ -104,16 +104,15 @@
     "    output += f'## codeaudit {key}\\n' # newlines matter when creating markdown\n",
     "    output += '```text\\n' # raw display    \n",
     "    func_name = value\n",
-    "    output += getattr(codeaudit, func_name).__doc__\n",
-    "    #print(func_name.__doc__)    \n",
+    "    output += getattr(corecli, func_name).__doc__    \n",
     "    output += func_name.__doc__    \n",
     "    output += '\\n' # newlines matter when creating markdown\n",
     "    output += '```\\n' "
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 17,
+   "execution_count": 9,
    "id": "0335783c-7676-4099-94c5-c98cc8f2f205",
    "metadata": {
     "editable": true,
@@ -134,7 +133,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 18,
+   "execution_count": 10,
    "id": "4667d7ec-3727-4e2d-97b5-6f597c697ec7",
    "metadata": {},
    "outputs": [],
@@ -167,7 +166,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.13.11"
+   "version": "3.14.4"
   }
  },
  "nbformat": 4,

docs/about.md

@@ -28,7 +28,7 @@ Use this Playbook to create better and faster security solutions for your securi
 :::
 
 :::{grid-item-card}
-:link: https://nocomplexity.com/documents/securitybydesign/intro.html
+:link: http://securitybydesign.nocomplexity.com/
 :link-type: url
 {octicon}`book;2em;caption-text` **Security By Design**        
 ^^^

docs/apidocs/modules.rst

@@ -1,5 +1,6 @@
-API Reference 
-==============
+API Reference
+=============
+
 
 .. toctree::
    :maxdepth: 4

docs/codeauditcommands.md

@@ -1,6 +1,6 @@
 % THIS FILE IS GENERATED! - Use CLIcommands.ipynb to make it better!
 # Commands Overview
-Python Code Audit commands for: version: 1.6.3.dev39+ga990bb23a.d20260411
+Python Code Audit commands for: version: 1.6.5rc4
 ```
 ----------------------------------------------------
  _                    __             _             

docs/examples/ca_checks.ipynb

@@ -5,17 +5,11 @@
    "id": "67936457-a2c4-40e3-bf53-93c8b5186fb6",
    "metadata": {},
    "source": [
-    "# Python Code Audit Implemented validations"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "d930de74-74c9-457a-b46e-a444ccb941c3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from codeaudit import codeaudit"
+    "# Python Code Audit Implemented validations\n",
+    "\n",
+    "Notebook which result is incorporated in the Python Code Audit manual.\n",
+    "\n",
+    "This notebook serves as the primary source for the Python Code Audit Manual. By integrating these results directly into the documentation, we ensure the manual remains technically accurate and reflects the most current validation data.\n"
    ]
   },
   {
@@ -45,7 +39,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.13.11"
+   "version": "3.14.4"
   }
  },
  "nbformat": 4,

docs/examples/codeauditchecks.html

@@ -311,6 +311,12 @@
       <td>High</td>
       <td>This function can execute arbitrary code and should be used only with validated constructs.</td>
     </tr>
+    <tr>
+      <td>Insecure FTP use</td>
+      <td>ftplib.FTP</td>
+      <td>High</td>
+      <td>Never use this. Sends usernames and passwords in plain text and transfers data unencrypted.</td>
+    </tr>
     <tr>
       <td>Gzip File Handling</td>
       <td>gzip.open</td>
@@ -738,4 +744,4 @@
       <td>Vulnerable to path traversal attacks if used with untrusted archives.</td>
     </tr>
   </tbody>
-</table><br><p>Number of implemented security validations:<b>83</b></p><p>Version of codeaudit: <b>1.6.3.dev39+ga990bb23a.d20260411</b><p>Because Python and cybersecurity are constantly changing, issue reports <b>SHOULD</b> specify the codeaudit version used.</p><p><b>Disclaimer:</b> <i>This SAST tool <a href="https://github.com/nocomplexity/codeaudit" target="_blank"><b>Python Code Audit</b></a> provides a powerful, automatic security analysis for Python source code. However, it's not a substitute for human review in combination with business knowledge. Undetected vulnerabilities may still exist.</i></p><p>This Python security report was created on: <b>2026-04-20 17:38</b> with <a href="https://github.com/nocomplexity/codeaudit" target="_blank"><b>Python Code Audit</b></a> version <b>1.6.3.dev39+ga990bb23a.d20260411</b></p><hr><footer><div class="footer-links">Check the <a href="https://nocomplexity.com/documents/codeaudit/intro.html" target="_blank">documentation</a> for help on found issues.<br>Codeaudit is made with <span class="heart">&#10084;</span> by cyber security professionals who advocate for <a href="https://nocomplexity.com/simplify-security/" target="_blank">open simple security solutions</a>.<br><a href="https://nocomplexity.com/documents/codeaudit/CONTRIBUTE.html" target="_blank">Join the community</a> and contribute to make this tool better!</div></footer></div></body></html>
+</table><br><p>Number of implemented security validations:<b>84</b></p><p>Version of codeaudit: <b>1.6.5rc4</b><p>Because Python and cybersecurity are constantly changing, issue reports <b>SHOULD</b> specify the codeaudit version used.</p><p><b>Disclaimer:</b> <i>This SAST tool <a href="https://github.com/nocomplexity/codeaudit" target="_blank"><b>Python Code Audit</b></a> provides a powerful, automatic security analysis for Python source code. However, it's not a substitute for human review in combination with business knowledge. Undetected vulnerabilities may still exist.</i></p><p>This Python security report was created on: <b>2026-05-11 16:12</b> with <a href="https://github.com/nocomplexity/codeaudit" target="_blank"><b>Python Code Audit</b></a> version <b>1.6.5rc4</b></p><hr><footer><div class="footer-links">Check the <a href="https://nocomplexity.com/documents/codeaudit/intro.html" target="_blank">documentation</a> for help on found issues.<br>Codeaudit is made with <span class="heart">&#10084;</span> by cyber security professionals who advocate for <a href="https://nocomplexity.com/simplify-security/" target="_blank">open simple security solutions</a>.<br><a href="https://nocomplexity.com/documents/codeaudit/CONTRIBUTE.html" target="_blank">Join the community</a> and contribute to make this tool better!</div></footer></div></body></html>

docs/examples/demoscan.json

@@ -1,7 +1,7 @@
 {
   "name": "Python_Code_Audit",
-  "version": "1.6.5rc3",
-  "generated_on": "2026-05-02 14:26",
+  "version": "1.6.5rc4",
+  "generated_on": "2026-05-11 16:12",
   "file_security_info": {
     "0": {
       "FileName": "demofile.py",

docs/intro.md

@@ -21,7 +21,6 @@
 In the Getting Started section you can find installation instructions and a high-level overview of the main concepts.
 +++
 ```{button-ref} installation
-:link-type: ref
 :color: danger
 Quick Start Guide
 ```
@@ -33,7 +32,6 @@ Quick Start Guide
 Check out the User Guides for in-depth information on the key concepts of Python Code Audit.
 +++
 ```{button-ref} userguide
-:link-type: ref
 :color: danger
 User Guide
 ```
@@ -53,7 +51,6 @@ The API reference guide contains detailed information on all methods to create y
 
 +++
 ```{button-ref} apidocs/modules
-:link-type: ref
 :color: danger
 API Reference
 ```
@@ -67,7 +64,6 @@ The contributing guidelines will guide you!
 
 +++
 ```{button-ref} CONTRIBUTE
-:link-type: ref
 :color: danger
 Contribute and Join the team!
 ```
@@ -131,7 +127,7 @@ Enjoying **Python Code Audit**? Support us with a [GitHub star](https://github.c
 
 ## Background
 
-The availability of good, maintained FOSS SAST tools for Python is limited. While Bandit is a known tool, its usefulness is significantly limited: it struggles to identify a broad range of security weaknesses and fails to perform many crucial Python security validations. Additionally, its Command Line Interface (CLI) can present a steep learning curve for non-technical users. 
+The availability of well-maintained, open source SAST tools for Python is limited. While Bandit is a known tool, its usefulness is significantly limited. It struggles to identify a broad range of security weaknesses and fails to perform many crucial Python security validations based on modules from the Python Standard Library. Additionally, its Command Line Interface (CLI) can present a steep learning curve for non-technical users. 
 To keep up with current threats, you need a Python Application Security Testing tool that evolves to deliver deeper insights and [high accuracy](https://nocomplexity.com/stop-using-bandit/).
 
 
@@ -140,7 +136,7 @@ To keep up with current threats, you need a Python Application Security Testing
 :::{note}
 This `Python Code Audit` tool is built to be fast, lightweight, and easy to use.
 
-By default, the tool scans Python code against more than **83 rules** to detect potential security vulnerabilities. These rules target unsafe constructs of the standard Python libraries that could pose a security risk. 
+By default, the tool scans Python code against more than **84 rules** to detect potential security vulnerabilities. These rules target unsafe constructs of the standard Python libraries that could pose a security risk. 
 
 :::
 

docs/makeitbetter.md

@@ -6,7 +6,7 @@ Great that you’re here at this section and want to contribute with code improv
 
 :::{admonition} Be sure to check out our Code of Conduct
 :class: note
-This project values respect and inclusiveness, and enforces a [Code of Conduct](CONTRIBUTE.md#code-of-conduct) in all interactions. This to ensure that our online spaces are enjoyable, inclusive, and productive for all contributors.
+This project values respect and inclusiveness, and enforces a [Code of Conduct](CoC-label) in all interactions. This to ensure that our online spaces are enjoyable, inclusive, and productive for all contributors.
 
 
 We adopt the [Collective Code Construction Contract(C4)](https://rfc.zeromq.org/spec/42/) to streamline collaboration. C4 is meant to provide a reusable optimal collaboration model for open source software projects.