refactor: run source code analysis by default (#1107)

--analyze-source CLI arg removed so Semgrep is now run by default. Automatic API docs update also run.

Signed-off-by: Carl Flottmann <[email protected]>

Author: art1f1c3R

docs/source/pages/cli_usage/command_analyze.rst

@@ -86,11 +86,7 @@ Options
 
 .. option:: --force-analyze-source
 
-    Forces PyPI sourcecode analysis to run regardless of other heuristic results. Requires '--analyze-source'.
-
-.. option:: --analyze-source
-
-    For improved malware detection, analyze the source code of the (PyPI) package using a textual scan and dataflow analysis.
+    Forces PyPI sourcecode analysis to run regardless of other heuristic results.
 
 -----------
 Environment

docs/source/pages/developers_guide/apidoc/macaron.code_analyzer.rst

@@ -3,8 +3,8 @@ macaron.code\_analyzer package
 
 .. automodule:: macaron.code_analyzer
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 Submodules
 ----------
@@ -14,5 +14,5 @@ macaron.code\_analyzer.call\_graph module
 
 .. automodule:: macaron.code_analyzer.call_graph
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:

docs/source/pages/developers_guide/apidoc/macaron.config.rst

@@ -3,8 +3,8 @@ macaron.config package
 
 .. automodule:: macaron.config
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 Submodules
 ----------
@@ -14,21 +14,21 @@ macaron.config.defaults module
 
 .. automodule:: macaron.config.defaults
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.config.global\_config module
 ------------------------------------
 
 .. automodule:: macaron.config.global_config
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.config.target\_config module
 ------------------------------------
 
 .. automodule:: macaron.config.target_config
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:

docs/source/pages/developers_guide/apidoc/macaron.database.rst

@@ -3,8 +3,8 @@ macaron.database package
 
 .. automodule:: macaron.database
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 Submodules
 ----------
@@ -14,29 +14,29 @@ macaron.database.database\_manager module
 
 .. automodule:: macaron.database.database_manager
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.database.db\_custom\_types module
 -----------------------------------------
 
 .. automodule:: macaron.database.db_custom_types
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.database.table\_definitions module
 ------------------------------------------
 
 .. automodule:: macaron.database.table_definitions
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.database.views module
 -----------------------------
 
 .. automodule:: macaron.database.views
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:

docs/source/pages/developers_guide/apidoc/macaron.dependency_analyzer.rst

@@ -3,8 +3,8 @@ macaron.dependency\_analyzer package
 
 .. automodule:: macaron.dependency_analyzer
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 Submodules
 ----------
@@ -14,29 +14,29 @@ macaron.dependency\_analyzer.cyclonedx module
 
 .. automodule:: macaron.dependency_analyzer.cyclonedx
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.dependency\_analyzer.cyclonedx\_gradle module
 -----------------------------------------------------
 
 .. automodule:: macaron.dependency_analyzer.cyclonedx_gradle
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.dependency\_analyzer.cyclonedx\_mvn module
 --------------------------------------------------
 
 .. automodule:: macaron.dependency_analyzer.cyclonedx_mvn
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.dependency\_analyzer.cyclonedx\_python module
 -----------------------------------------------------
 
 .. automodule:: macaron.dependency_analyzer.cyclonedx_python
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:

docs/source/pages/developers_guide/apidoc/macaron.malware_analyzer.pypi_heuristics.metadata.rst

@@ -3,8 +3,8 @@ macaron.malware\_analyzer.pypi\_heuristics.metadata package
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics.metadata
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 Submodules
 ----------
@@ -14,61 +14,69 @@ macaron.malware\_analyzer.pypi\_heuristics.metadata.anomalous\_version module
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics.metadata.anomalous_version
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.malware\_analyzer.pypi\_heuristics.metadata.closer\_release\_join\_date module
 --------------------------------------------------------------------------------------
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics.metadata.closer_release_join_date
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.malware\_analyzer.pypi\_heuristics.metadata.empty\_project\_link module
 -------------------------------------------------------------------------------
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics.metadata.empty_project_link
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.malware\_analyzer.pypi\_heuristics.metadata.high\_release\_frequency module
 -----------------------------------------------------------------------------------
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics.metadata.high_release_frequency
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.malware\_analyzer.pypi\_heuristics.metadata.one\_release module
 -----------------------------------------------------------------------
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics.metadata.one_release
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.malware\_analyzer.pypi\_heuristics.metadata.source\_code\_repo module
 -----------------------------------------------------------------------------
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics.metadata.source_code_repo
    :members:
+   :show-inheritance:
    :undoc-members:
+
+macaron.malware\_analyzer.pypi\_heuristics.metadata.typosquatting\_presence module
+----------------------------------------------------------------------------------
+
+.. automodule:: macaron.malware_analyzer.pypi_heuristics.metadata.typosquatting_presence
+   :members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.malware\_analyzer.pypi\_heuristics.metadata.unchanged\_release module
 -----------------------------------------------------------------------------
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics.metadata.unchanged_release
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.malware\_analyzer.pypi\_heuristics.metadata.wheel\_absence module
 -------------------------------------------------------------------------
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics.metadata.wheel_absence
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:

docs/source/pages/developers_guide/apidoc/macaron.malware_analyzer.pypi_heuristics.rst

@@ -3,8 +3,8 @@ macaron.malware\_analyzer.pypi\_heuristics package
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 Subpackages
 -----------
@@ -23,13 +23,13 @@ macaron.malware\_analyzer.pypi\_heuristics.base\_analyzer module
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics.base_analyzer
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.malware\_analyzer.pypi\_heuristics.heuristics module
 ------------------------------------------------------------
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics.heuristics
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:

docs/source/pages/developers_guide/apidoc/macaron.malware_analyzer.pypi_heuristics.sourcecode.rst

@@ -3,8 +3,8 @@ macaron.malware\_analyzer.pypi\_heuristics.sourcecode package
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics.sourcecode
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 Submodules
 ----------
@@ -14,13 +14,13 @@ macaron.malware\_analyzer.pypi\_heuristics.sourcecode.pypi\_sourcecode\_analyzer
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics.sourcecode.pypi_sourcecode_analyzer
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.malware\_analyzer.pypi\_heuristics.sourcecode.suspicious\_setup module
 ------------------------------------------------------------------------------
 
 .. automodule:: macaron.malware_analyzer.pypi_heuristics.sourcecode.suspicious_setup
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:

docs/source/pages/developers_guide/apidoc/macaron.malware_analyzer.rst

@@ -3,8 +3,8 @@ macaron.malware\_analyzer package
 
 .. automodule:: macaron.malware_analyzer
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 Subpackages
 -----------
@@ -22,5 +22,5 @@ macaron.malware\_analyzer.datetime\_parser module
 
 .. automodule:: macaron.malware_analyzer.datetime_parser
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:

docs/source/pages/developers_guide/apidoc/macaron.output_reporter.rst

@@ -3,8 +3,8 @@ macaron.output\_reporter package
 
 .. automodule:: macaron.output_reporter
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 Submodules
 ----------
@@ -14,29 +14,29 @@ macaron.output\_reporter.jinja2\_extensions module
 
 .. automodule:: macaron.output_reporter.jinja2_extensions
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.output\_reporter.reporter module
 ----------------------------------------
 
 .. automodule:: macaron.output_reporter.reporter
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.output\_reporter.results module
 ---------------------------------------
 
 .. automodule:: macaron.output_reporter.results
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.output\_reporter.scm module
 -----------------------------------
 
 .. automodule:: macaron.output_reporter.scm
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:

docs/source/pages/developers_guide/apidoc/macaron.parsers.rst

@@ -3,8 +3,8 @@ macaron.parsers package
 
 .. automodule:: macaron.parsers
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 Subpackages
 -----------
@@ -22,29 +22,29 @@ macaron.parsers.actionparser module
 
 .. automodule:: macaron.parsers.actionparser
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.parsers.bashparser module
 ---------------------------------
 
 .. automodule:: macaron.parsers.bashparser
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.parsers.github\_workflow\_model module
 ----------------------------------------------
 
 .. automodule:: macaron.parsers.github_workflow_model
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 macaron.parsers.pomparser module
 --------------------------------
 
 .. automodule:: macaron.parsers.pomparser
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members: