codeaudit 0.5.4__tar.gz → 0.5.5__tar.gz

{codeaudit-0.5.4 → codeaudit-0.5.5}/.gitignore

@@ -145,5 +145,5 @@ dmypy.json
 ## NOCX
 _build/*
 .gitignore
-docs
+
 

codeaudit-0.5.5/CONTRIBUTE.md

@@ -0,0 +1,64 @@
+# Contribute
+
+Great that you see this page and want to contribute!
+
+:::{tip}
+All contributions are welcome!
+Think of corrections on the manual, code and more or better tests.
+:::
+
+The **Codeaudit** code repository is hosted at [Github](github.com/nocomplexity/codeaudit).
+
+Simple Guidelines:
+
+* Questions, Feature Requests, Bug Reports should all be reported on the [Github Issue Tracker](https://github.com/nocomplexity/codeaudit/issues) .
+* [Black](https://black.readthedocs.io/en/stable/index.html) is used for code style. But for a simple fix, using `Black` is not required!
+
+This codeaudit tool is designed by applying [Zero Complexity By Design principles](https://nocomplexity.com/documents/0complexity/abstract.html). So the goal is to keep the tool simple to use and the code simple to adjust or to extend.
+
+:::{warning}
+This simple tool is designed to be simple to use and maintain. 
+:::
+
+**Pull Requests are welcome!** 
+
+When you contribute to Codeaudit, your contributions are made under the same license as the file you are working on. 
+
+
+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. 
+
+:::{attention} 
+This project values respect and inclusiveness, and enforces a [Code of Conduct](CoC-label) in all interactions.
+:::
+
+
+:::{note} 
+This is an open community driven project. Contributors will be mentioned in the documentation.
+:::
+
+(CoC-label)=
+## Code of Conduct
+
+Version : 1.0 
+
+As contributors, maintainers, administrators and founders of the Python Codeaudit Community projects, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+*    The use of sexualized language or imagery.
+*    Personal attacks.
+*    Trolling or insulting/derogatory comments.
+*    Public or private harassment.
+*    Publishing other’s private information, such as physical or electronic addresses, without explicit permission.
+*    Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, documentation edits, issues, and other contributions that are not aligned to this Code of Conduct. 
+
+By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](https://www.contributor-covenant.org/version/1/2/0/code-of-conduct/).

{codeaudit-0.5.4 → codeaudit-0.5.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codeaudit
-Version: 0.5.4
+Version: 0.5.5
 Summary: Simplified static security checks for Python 
 Project-URL: Documentation, https://github.com/nocomplexity/codeaudit#readme
 Project-URL: Issues, https://github.com/nocomplexity/codeaudit/issues
@@ -24,14 +24,16 @@ Requires-Dist: fire>=0.7.0
 Requires-Dist: pandas>=2.3
 Description-Content-Type: text/markdown
 
-# codeaudit
+# Codeaudit
+
+![CodeauditLogo](docs/images/codeauditlogo.png)
 
 [![PyPI - Version](https://img.shields.io/pypi/v/codeaudit.svg)](https://pypi.org/project/codeaudit)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/codeaudit.svg)](https://pypi.org/project/codeaudit)
 
-Codeaudit - A modern Python source code analyzer based on distrust.
+Python Codeaudit - A modern Python source code analyzer based on distrust.
 
-Codeaudit is a tool designed to find security issues in Python code. This static application security testing (SAST) tool has great features to simplify the necessary security tasks and make it fun and easy. 
+Codeaudit is a tool to find security issues in Python code. This static application security testing (SAST) tool has **great** features to simplify the necessary security tasks and make it fun and easy. 
 
 This tool is created for:
 * Anyone who want or must check security risks with Python programs.
@@ -40,20 +42,20 @@ This tool is created for:
 
 
 > [!WARNING]
-> Codeaudit is still is currently in *beta status*. There are still bugs in the software that need to be fixed. Consider [contributing](CONTRIBUTING.md) to make Codeaudit a cool modern Python SAST tool. Codeaudit is currently in a thorough testing period and changes and fixes are frequently applied. 
+> Python Codeaudit is currently in *beta status*. Consider [contributing](CONTRIBUTING.md) to make Codeaudit the coolest open source Python SAST tool. Codeaudit is currently in a thorough testing phase. So use the Codeaudit now to and contribute to make it better!
 
 ## Features
 
-Codeaudit has the following features:
+Python Codeaudit has the following features:
 
 * Detecting and reporting potential vulnerabilities of from all Python files collected in a directory. This is a must **do** check when researching python packages on possible security issues.
 
 *  Detect and reports complexity and statistics relevant for security per Python file or from Python files found in a directory. 
 
-* Codeaudit implements a light weight [cyclomatic complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) using Python’s Abstract Syntax Tree module. The codeaudit implemented check is by far good enough for determining security risks in Python files very quick!
+* Python Codeaudit implements a light weight [cyclomatic complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) count, using Python’s Abstract Syntax Tree module. The codeaudit complexity check is designed to determine security risks in Python files very quick!
 
 
-*  Detect and reports which module are used within a Python file. Also vulnerability information found from used external modules is shown.
+*  Detect and reports which module are used within a Python file. Also vulnerability information found from used external modules is reported.
 
 *  Detecting and reporting potential vulnerability issues within a Python file. Per detected issue the line number shown, with the lines that *could* cause a security issue.
 
@@ -61,7 +63,7 @@ Codeaudit has the following features:
 
 
 > [!IMPORTANT]
-> Codeaudit uses the Python's Abstract Syntax Tree (AST) to get robust and reliable result. Using the Python AST makes contextual Vulnerability Detection possible and false positive are minimized.
+> Python Codeaudit uses the Python's Abstract Syntax Tree (AST) to get robust and reliable result. Using the Python AST makes contextual Vulnerability Detection possible and false positive are minimized.
 
 
 ## Installation
@@ -113,7 +115,7 @@ Commands:
   checks               Generate an HTML report of all implemented codeaudit security checks.
   version              Prints the module version. Use [-v] [--v] [-version] or [--version].
 
-Use the Codeaudit documentation to check the security of Python programs and make your Python programs more secure!
+Use the [Codeaudit documentation](https://nocomplexity.com/documents/codeaudit/intro.html) to check the security of Python programs and make your Python programs more secure!
 Check https://simplifysecurity.nocomplexity.com/ 
 ```
 
@@ -150,7 +152,7 @@ When you contribute to Codeaudit, your contributions are made under the same lic
 
 
 > [!NOTE]
-> This is an open community driven project. Contributors will be mentioned in the documentation.
+> This is an open community driven project. Contributors will be mentioned in the [documentation](https://nocomplexity.com/documents/codeaudit/intro.html).
 
 We adopt the [Collective Code Construction Contract(C4)](https://rfc.zeromq.org/spec/42/) to streamline collaboration.
 

{codeaudit-0.5.4 → codeaudit-0.5.5}/README.md

@@ -1,11 +1,13 @@
-# codeaudit
+# Codeaudit
+
+![CodeauditLogo](docs/images/codeauditlogo.png)
 
 [![PyPI - Version](https://img.shields.io/pypi/v/codeaudit.svg)](https://pypi.org/project/codeaudit)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/codeaudit.svg)](https://pypi.org/project/codeaudit)
 
-Codeaudit - A modern Python source code analyzer based on distrust.
+Python Codeaudit - A modern Python source code analyzer based on distrust.
 
-Codeaudit is a tool designed to find security issues in Python code. This static application security testing (SAST) tool has great features to simplify the necessary security tasks and make it fun and easy. 
+Codeaudit is a tool to find security issues in Python code. This static application security testing (SAST) tool has **great** features to simplify the necessary security tasks and make it fun and easy. 
 
 This tool is created for:
 * Anyone who want or must check security risks with Python programs.
@@ -14,20 +16,20 @@ This tool is created for:
 
 
 > [!WARNING]
-> Codeaudit is still is currently in *beta status*. There are still bugs in the software that need to be fixed. Consider [contributing](CONTRIBUTING.md) to make Codeaudit a cool modern Python SAST tool. Codeaudit is currently in a thorough testing period and changes and fixes are frequently applied. 
+> Python Codeaudit is currently in *beta status*. Consider [contributing](CONTRIBUTING.md) to make Codeaudit the coolest open source Python SAST tool. Codeaudit is currently in a thorough testing phase. So use the Codeaudit now to and contribute to make it better!
 
 ## Features
 
-Codeaudit has the following features:
+Python Codeaudit has the following features:
 
 * Detecting and reporting potential vulnerabilities of from all Python files collected in a directory. This is a must **do** check when researching python packages on possible security issues.
 
 *  Detect and reports complexity and statistics relevant for security per Python file or from Python files found in a directory. 
 
-* Codeaudit implements a light weight [cyclomatic complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) using Python’s Abstract Syntax Tree module. The codeaudit implemented check is by far good enough for determining security risks in Python files very quick!
+* Python Codeaudit implements a light weight [cyclomatic complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) count, using Python’s Abstract Syntax Tree module. The codeaudit complexity check is designed to determine security risks in Python files very quick!
 
 
-*  Detect and reports which module are used within a Python file. Also vulnerability information found from used external modules is shown.
+*  Detect and reports which module are used within a Python file. Also vulnerability information found from used external modules is reported.
 
 *  Detecting and reporting potential vulnerability issues within a Python file. Per detected issue the line number shown, with the lines that *could* cause a security issue.
 
@@ -35,7 +37,7 @@ Codeaudit has the following features:
 
 
 > [!IMPORTANT]
-> Codeaudit uses the Python's Abstract Syntax Tree (AST) to get robust and reliable result. Using the Python AST makes contextual Vulnerability Detection possible and false positive are minimized.
+> Python Codeaudit uses the Python's Abstract Syntax Tree (AST) to get robust and reliable result. Using the Python AST makes contextual Vulnerability Detection possible and false positive are minimized.
 
 
 ## Installation
@@ -87,7 +89,7 @@ Commands:
   checks               Generate an HTML report of all implemented codeaudit security checks.
   version              Prints the module version. Use [-v] [--v] [-version] or [--version].
 
-Use the Codeaudit documentation to check the security of Python programs and make your Python programs more secure!
+Use the [Codeaudit documentation](https://nocomplexity.com/documents/codeaudit/intro.html) to check the security of Python programs and make your Python programs more secure!
 Check https://simplifysecurity.nocomplexity.com/ 
 ```
 
@@ -124,7 +126,7 @@ When you contribute to Codeaudit, your contributions are made under the same lic
 
 
 > [!NOTE]
-> This is an open community driven project. Contributors will be mentioned in the documentation.
+> This is an open community driven project. Contributors will be mentioned in the [documentation](https://nocomplexity.com/documents/codeaudit/intro.html).
 
 We adopt the [Collective Code Construction Contract(C4)](https://rfc.zeromq.org/spec/42/) to streamline collaboration.
 

codeaudit-0.5.5/docs/CLIcommands.ipynb

@@ -0,0 +1,168 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "6e4cc5f7-58db-4fc9-a5be-b5c75db9b2c1",
+   "metadata": {},
+   "source": [
+    "# Codeaudit CLI Commands\n",
+    "\n",
+    "Generated overview of codeaudit implemented commands.\n",
+    "So always up-to-date with the code!"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "923aba22-7103-4431-8545-ee5596efa371",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from codeaudit import codeaudit"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "057c9730-7b09-49a8-82f1-bc681d880c96",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "output = ''"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "67576531-b66f-42a3-b6e4-460423ca28e0",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%capture version --no-display\n",
+    "codeaudit.display_version()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "2717fe66-9e66-4fcc-ae82-0d1ba26892c4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "version_id = version.stdout"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "3f286724-0a8f-45b2-80fe-d6d061fe440a",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "output += '% THIS FILE IS GENERATED! - Use CLIcommands.ipynb to make it better!\\n'\n",
+    "output += '# Overview of Codeaudit commands\\n'\n",
+    "output += f'Codeaudit commands for: {version_id}'"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "693c3354-530b-4a40-a561-ed722d9bb1fa",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%capture helpoutput --no-display\n",
+    "codeaudit.display_help()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "5fa9a420-bd9a-4641-99c9-de0bcf448dbc",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "output += '```' # raw display\n",
+    "output += helpoutput.stdout\n",
+    "output += '```' # end raw display\n",
+    "output += '\\n' # newlines matter when creating markdown"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "bf6afe56-e0f7-4fa2-a3a5-968bad11bf9c",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "commands = {  \"overview\": 'overview_report',               \n",
+    "                \"modulescan\": 'report_module_information',\n",
+    "                \"filescan\" : 'file_scan_report',\n",
+    "                \"directoryscan\" : 'directory_scan_report',\n",
+    "                \"checks\" : 'report_implemented_tests',\n",
+    "               \"version\" : 'display_version'} \n",
+    "for key, value in commands.items():    \n",
+    "    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 += func_name.__doc__    \n",
+    "    output += '\\n' # newlines matter when creating markdown\n",
+    "    output += '```\\n' "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "0335783c-7676-4099-94c5-c98cc8f2f205",
+   "metadata": {
+    "editable": true,
+    "slideshow": {
+     "slide_type": ""
+    },
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "def create_documentation_file(output):\n",
+    "    \"\"\"Creates a MyST file for the documentation\"\"\"\n",
+    "    outputfile= \"codeauditcommands.md\"\n",
+    "    with open(outputfile, 'w') as f:\n",
+    "        f.write(output)    \n",
+    "    "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "4667d7ec-3727-4e2d-97b5-6f597c697ec7",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "create_documentation_file(output)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.13.1"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

codeaudit-0.5.5/docs/CONTRIBUTE.md

@@ -0,0 +1,64 @@
+# Contribute
+
+Great that you see this page and want to contribute!
+
+:::{tip}
+All contributions are welcome!
+Think of corrections on the manual, code and more or better tests.
+:::
+
+The **Codeaudit** code repository is hosted at [Github](github.com/nocomplexity/codeaudit).
+
+Simple Guidelines:
+
+* Questions, Feature Requests, Bug Reports should all be reported on the [Github Issue Tracker](https://github.com/nocomplexity/codeaudit/issues) .
+* [Black](https://black.readthedocs.io/en/stable/index.html) is used for code style. But for a simple fix, using `Black` is not required!
+
+This codeaudit tool is designed by applying [Zero Complexity By Design principles](https://nocomplexity.com/documents/0complexity/abstract.html). So the goal is to keep the tool simple to use and the code simple to adjust or to extend.
+
+:::{warning}
+This simple tool is designed to be simple to use and maintain. 
+:::
+
+**Pull Requests are welcome!** 
+
+When you contribute to Codeaudit, your contributions are made under the same license as the file you are working on. 
+
+
+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. 
+
+:::{attention} 
+This project values respect and inclusiveness, and enforces a [Code of Conduct](CoC-label) in all interactions.
+:::
+
+
+:::{note} 
+This is an open community driven project. Contributors will be mentioned in the documentation.
+:::
+
+(CoC-label)=
+## Code of Conduct
+
+Version : 1.0 
+
+As contributors, maintainers, administrators and founders of the Python Codeaudit Community projects, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+*    The use of sexualized language or imagery.
+*    Personal attacks.
+*    Trolling or insulting/derogatory comments.
+*    Public or private harassment.
+*    Publishing other’s private information, such as physical or electronic addresses, without explicit permission.
+*    Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, documentation edits, issues, and other contributions that are not aligned to this Code of Conduct. 
+
+By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](https://www.contributor-covenant.org/version/1/2/0/code-of-conduct/).

codeaudit-0.5.5/docs/_config.yml

@@ -0,0 +1,105 @@
+#######################################################################################
+# The NO Complexity default configuration configuration making jupyter books
+# Override these values in their own `_config.yml` file.
+# Created by Maikel Mardjan (nocomplexity.com)
+#######################################################################################
+# Book settings
+#title                       : SimplifiedNLP Documentation # The title of the book. Will be placed in the left navbar.
+title : ""
+author                      : '<a href="https://nocomplexity.com/">Maikel Mardjan (nocomplexity.com)</a>' # The author of the book
+copyright                   : '2025- Maikel Mardjan - Business Management Support Foundation'  # Copyright year to be placed in the footer
+logo                        : "images/nocxbanner.png"  # A path to the book logo
+# Patterns to skip when building the book. Can be glob-style (e.g. "*skip.ipynb")
+exclude_patterns            : [_build, Thumbs.db, .DS_Store, "**.ipynb_checkpoints"]
+# Auto-exclude files not in the toc
+only_build_toc_files        : false
+
+#######################################################################################
+# Execution settings
+execute:
+  execute_notebooks         : auto  # Whether to execute notebooks at build time. Must be one of ("auto", "force", "cache", "off")
+  cache                     : ""    # A path to the jupyter cache that will be used to store execution artifacs. Defaults to `_build/.jupyter_cache/`
+  exclude_patterns          : []    # A list of patterns to *skip* in execution (e.g. a notebook that takes a really long time)
+  timeout                   : 30    # The maximum time (in seconds) each notebook cell is allowed to run.
+  run_in_temp               : false # If `True`, then a temporary directory will be created and used as the command working directory (cwd),
+                                    # otherwise the notebook's parent directory will be the cwd.
+  allow_errors              : false # If `False`, when a code cell raises an error the execution is stopped, otherwise all cells are always run.
+  stderr_output             : show  # One of 'show', 'remove', 'remove-warn', 'warn', 'error', 'severe'
+
+#######################################################################################
+# Parse and render settings
+parse:
+  myst_enable_extensions:  # default extensions to enable in the myst parser. See https://myst-parser.readthedocs.io/en/latest/using/syntax-optional.html
+    - amsmath
+    - colon_fence
+    - deflist
+    - dollarmath
+    - html_admonition
+    - html_image
+    - linkify
+    - replacements
+    - smartquotes
+    - substitution
+
+  myst_url_schemes          : [mailto, http, https]  # URI schemes that will be recognised as external URLs in Markdown links
+
+#######################################################################################
+# HTML-specific settings
+html:
+  # favicon                   : ""  # A path to a favicon image
+  # use_edit_page_button      : true  # Whether to add an "edit this page" button to pages. If `true`, repository information in repository: must be filled in
+  # use_repository_button     : true  # Whether to add a link to your repository button
+  # use_issues_button         : true  # Whether to add an "open an issue" button
+  
+  
+  #extra_footer              : '<p><a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a> © Copyright 2025, BM-Support.org - Maikel Mardjan. This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.</p>'
+  #extra_navbar              : '<a href="https://bm-support.org/"><b>ROI Now!</b></a>' #DOES NOT WORK ANYMORE!? (status May 2023)
+
+  home_page_in_navbar       : true  # Whether to include your home page in the left Navigation Bar
+  baseurl                   : ""  # The base URL where your book will be hosted. Used for creating image previews and social links. e.g.: https://mypage.com/mybook/
+  comments:
+    hypothesis              : false
+    utterances              : false
+  
+#######################################################################################
+# LaTeX-specific settings
+latex:
+  latex_engine              : pdflatex  # one of 'pdflatex', 'xelatex' (recommended for unicode), 'luatex', 'platex', 'uplatex'
+
+#######################################################################################
+# Launch button settings
+launch_buttons:
+  notebook_interface        : classic  # The interface interactive links will activate ["classic", "jupyterlab"]
+  binderhub_url             : https://mybinder.org  # The URL of the BinderHub (e.g., https://mybinder.org)
+  jupyterhub_url            : ""  # The URL of the JupyterHub (e.g., https://datahub.berkeley.edu)
+  thebe                     : false  # Add a thebe button to pages (requires the repository to run on Binder)
+  colab_url                 : "" # The URL of Google Colab (https://colab.research.google.com)
+
+
+#######################################################################################
+# Advanced and power-user settings
+sphinx:
+  extra_extensions          :     
+  - sphinx.ext.autodoc  
+  - sphinx.ext.viewcode  
+  - sphinx.ext.napoleon
+  - sphinx.ext.todo
+
+  local_extensions          :   # A list of local extensions to load by sphinx specified by "name: path" items  
+#     simplifiednlp :  '/home/maikel/projects/pythondev/simplifiednlp'
+  config:
+    html_show_copyright: false
+    html_last_updated_fmt: ""     
+    napoleon_google_docstring: true
+    napoleon_numpy_docstring: true
+    html_theme_options:        
+      repository_url: "https://github.com/nocomplexity/codeaudit"
+      repository_branch: "master" 
+      use_repository_button: True
+      use_edit_page_button: True
+      use_issues_button: True       
+      home_page_in_toc: True 
+      logo:
+           text: <b>Python Security Code Audit</b>
+      extra_footer: '<p><a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a> This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.</p>'
+      

codeaudit-0.5.5/docs/_static/nocxstyle.css

@@ -0,0 +1,25 @@
+.caption-text {
+    color: #FF0000;    
+}
+
+/* <your static path>/custom.css */
+
+div.admonition.admonition-nocx {
+    border-color: #FF0000;
+  }
+  div.admonition.admonition-nocx > .admonition-title:before {
+    background-color: #FF0000;
+  }
+  div.admonition.admonition-nocx > .admonition-title:after {
+    color: #FF0000;
+  }
+
+
+/* for the danger color (button!) to be NOCX red instead of the default*/
+/* 19-11-2023: --pst-color-secondary:  makes the TOC hover link red again, else purple by default*/
+
+html[data-theme="light"] {
+        --pst-color-danger: red;
+        --pst-color-secondary: #000;
+}
+

codeaudit-0.5.5/docs/_toc.yml

@@ -0,0 +1,67 @@
+format: jb-book
+root: intro
+
+parts:
+- caption: Quick Start
+  chapters:    
+  - file: features
+  - file: userguide
+    sections:
+    - file: codeauditoverview
+    - file: modulescan
+    - file: filescan
+    - file: directoryscan
+    - file: codeauditchecks
+  - file: whysast
+  
+
+- caption: Security Checks
+  chapters:
+  - file: checksinformation
+    sections:
+    - file: checks/assert_check
+    - file: checks/input_check
+    - file: checks/builtinfunctions_check
+    - file: checks/chmod_check
+    - file: checks/binding_check
+    - file: checks/directorycreation_check
+    - file: checks/exception_check
+    - file: checks/tarfile_extract_check
+    - file: checks/hash_check
+    - file: checks/marshal_check
+    - file: checks/subprocess_check
+    - file: checks/systemcalls_check
+    - file: checks/loggingconf_check
+    - file: checks/base64_check
+    - file: checks/httpserver_check
+    - file: checks/multiprocessing_check
+    - file: checks/pickle_check
+    - file: checks/random_check
+    - file: checks/shelve_check
+    - file: checks/xml_check
+    - file: checks/zipfile_check
+    - file: checks/shutil_check
+
+
+- caption: Architecture 
+  chapters:     
+  # - file: astlines
+  # - file: astlines2
+  - file: complexitycheck
+  - file: warnings
+  - file: codeauditcommands
+  
+  
+  
+# - caption: API Documentation
+#   chapters:  
+#   - file: modules
+      
+
+- caption: About
+  chapters:  
+  - file: help
+  - file: CONTRIBUTE
+  - file: sponsors
+  - file: license
+  - file: about