2023

FHPythonUtils · Jun 27, 2023 · 249f758 · 249f758
1 parent bf9a71b
commit 249f758
Show file tree

Hide file tree

Showing 17 changed files with 605 additions and 475 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,15 @@
 All major and minor version changes will be documented in this file. Details of
 patch-level version changes can be found in [commit messages](../../commits/master).
 
+## 2023 - 2023/06/27
+
+- Refactor to fix bugs and improve readability
+- Add `scan-dir` argument
+- Add support for levels/severity to `dlint`
+- Ensure `bandit` ignores relative files (see https://github.com/PyCQA/bandit/issues/975)
+- Fix bug with `safety` plugin where results were corrupted
+- Update deps
+
 ## 2022 - 2022/04/09
 
 - Move docs

diff --git a/documentation/reference/MODULES.md b/documentation/reference/MODULES.md
diff --git a/documentation/reference/README.md b/documentation/reference/README.md
@@ -1,12 +1,12 @@
-# Simplesecurity Modules
+# Simplesecurity Index
 
-> Auto-generated documentation modules index.
+> Auto-generated documentation index.
 
-Full list of [Simplesecurity](README.md#simplesecurity-index) project modules.
+A full list of `Simplesecurity` project modules.
 
-- [Simplesecurity Index](README.md#simplesecurity-index)
 - [Simplesecurity](simplesecurity/index.md#simplesecurity)
     - [Module](simplesecurity/module.md#module)
+    - [Excluded](simplesecurity/excluded.md#excluded)
     - [Filter](simplesecurity/filter.md#filter)
     - [Formatter](simplesecurity/formatter.md#formatter)
     - [Level](simplesecurity/level.md#level)

diff --git a/documentation/reference/simplesecurity/excluded.md b/documentation/reference/simplesecurity/excluded.md
@@ -0,0 +1,9 @@
+# Excluded
+
+[Simplesecurity Index](../README.md#simplesecurity-index) /
+[Simplesecurity](./index.md#simplesecurity) /
+Excluded
+
+> Auto-generated documentation for [simplesecurity.excluded](../../../simplesecurity/excluded.py) module.
+
+- [Excluded](#excluded)
diff --git a/documentation/reference/simplesecurity/filter.md b/documentation/reference/simplesecurity/filter.md
@@ -1,22 +1,20 @@
 # Filter
 
-> Auto-generated documentation for [simplesecurity.filter](../../../simplesecurity/filter.py) module.
+[Simplesecurity Index](../README.md#simplesecurity-index) /
+[Simplesecurity](./index.md#simplesecurity) /
+Filter
 
-Some of our analysis tools overlap one-another so lets remove duplicates.
+> Auto-generated documentation for [simplesecurity.filter](../../../simplesecurity/filter.py) module.
 
-- [Simplesecurity](../README.md#simplesecurity-index) / [Modules](../MODULES.md#simplesecurity-modules) / [Simplesecurity](index.md#simplesecurity) / Filter
-    - [deduplicate](#deduplicate)
-    - [filterSeverityAndConfidence](#filterseverityandconfidence)
-    - [findingsEqual](#findingsequal)
-    - [lookupId](#lookupid)
+- [Filter](#filter)
+  - [deduplicate](#deduplicate)
+  - [filterSeverityAndConfidence](#filterseverityandconfidence)
+  - [findingsEqual](#findingsequal)
+  - [lookupId](#lookupid)
 
 ## deduplicate
 
-[[find in source code]](../../../simplesecurity/filter.py#L58)
-
-```python
-def deduplicate(findings: list[Finding]) -> list[Finding]:
-```
+[Show source in filter.py:58](../../../simplesecurity/filter.py#L58)
 
 Deduplicate the list of findings.
 
@@ -28,21 +26,22 @@ Deduplicate the list of findings.
 
 - `list[Finding]` - new deduplicated list
 
+#### Signature
+
+```python
+def deduplicate(findings: list[Finding]) -> list[Finding]:
+    ...
+```
+
 #### See also
 
-- [Finding](types.md#finding)
+- [Finding](./types.md#finding)
 
-## filterSeverityAndConfidence
 
-[[find in source code]](../../../simplesecurity/filter.py#L78)
 
-```python
-def filterSeverityAndConfidence(
-    findings: list[Finding],
-    severity: int,
-    confidence: int,
-) -> list[Finding]:
-```
+## filterSeverityAndConfidence
+
+[Show source in filter.py:78](../../../simplesecurity/filter.py#L78)
 
 Filter the list of findings.
 
@@ -56,17 +55,24 @@ Filter the list of findings.
 
 - `list[Finding]` - new deduplicated list
 
+#### Signature
+
+```python
+def filterSeverityAndConfidence(
+    findings: list[Finding], severity: int, confidence: int
+) -> list[Finding]:
+    ...
+```
+
 #### See also
 
-- [Finding](types.md#finding)
+- [Finding](./types.md#finding)
 
-## findingsEqual
 
-[[find in source code]](../../../simplesecurity/filter.py#L36)
 
-```python
-def findingsEqual(findingA: Finding, findingB: Finding) -> int:
-```
+## findingsEqual
+
+[Show source in filter.py:36](../../../simplesecurity/filter.py#L36)
 
 Basically and __eq__ method for findings.
 
@@ -80,17 +86,22 @@ Basically and __eq__ method for findings.
 - `int` - 0 if not equal. 1 if lookup(left) is equal to right - bin left.
 -1 if lookup(right) is equal to left - bin right
 
+#### Signature
+
+```python
+def findingsEqual(findingA: Finding, findingB: Finding) -> int:
+    ...
+```
+
 #### See also
 
-- [Finding](types.md#finding)
+- [Finding](./types.md#finding)
 
-## lookupId
 
-[[find in source code]](../../../simplesecurity/filter.py#L22)
 
-```python
-def lookupId(identifier: str) -> list[str]:
-```
+## lookupId
+
+[Show source in filter.py:22](../../../simplesecurity/filter.py#L22)
 
 Lookup an id in the id map.
 
@@ -101,3 +112,12 @@ Lookup an id in the id map.
 #### Returns
 
 - `str` - id that it equals
+
+#### Signature
+
+```python
+def lookupId(identifier: str) -> list[str]:
+    ...
+```
+
+