2022.2

Author: FredHappyface

CHANGELOG.md

@@ -3,6 +3,12 @@
 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).
 
+## 2022.2.0 - 2022/10/22
+
+- Add support for `setup.cfg` https://github.com/FHPythonUtils/LicenseCheck/issues/21
+  (thank you https://github.com/NicolaDonelli for the code :))
+- Use rich for table rendering https://github.com/FHPythonUtils/LicenseCheck/issues/20
+
 ## 2022.1.1 - 2022/04/09
 
 - More detailed warnings per https://github.com/FHPythonUtils/LicenseCheck/issues/19

documentation/reference/MODULES.md

@@ -1,10 +1,9 @@
-# Licensecheck Modules
+# Licensecheck Index
 
-> Auto-generated documentation modules index.
+> Auto-generated documentation index.
 
-Full list of [Licensecheck](README.md#licensecheck-index) project modules.
+A full list of `Licensecheck` project modules.
 
-- [Licensecheck Index](README.md#licensecheck-index)
 - [Licensecheck](licensecheck/index.md#licensecheck)
     - [Module](licensecheck/module.md#module)
     - [Formatter](licensecheck/formatter.md#formatter)

documentation/reference/README.md

@@ -1,149 +1,173 @@
 # Formatter
 
+[Licensecheck Index](../README.md#licensecheck-index) /
+[Licensecheck](./index.md#licensecheck) /
+Formatter
+
 > Auto-generated documentation for [licensecheck.formatter](../../../licensecheck/formatter.py) module.
 
-Take our package compat dictionary and give things a pretty format.
-
-- [Licensecheck](../README.md#licensecheck-index) / [Modules](../MODULES.md#licensecheck-modules) / [Licensecheck](index.md#licensecheck) / Formatter
-    - [ansi](#ansi)
-    - [csv](#csv)
-    - [json](#json)
-    - [markdown](#markdown)
-    - [simple](#simple)
-
-```json
-{
- name: str
- version: str
- namever: str
- size: int
- home_page: str
- author: str
- license: str
- license_compat: bool
-}
-```
+- [Formatter](#formatter)
+  - [ansi](#ansi)
+  - [markdown](#markdown)
+  - [plainText](#plaintext)
+  - [raw](#raw)
+  - [rawCsv](#rawcsv)
+  - [stripAnsi](#stripansi)
 
-Formats
+## ansi
 
-- markdown
-- json
-- csv
-- ansi
+[Show source in formatter.py:50](../../../licensecheck/formatter.py#L50)
 
-## ansi
+Format to ansi
 
-[[find in source code]](../../../licensecheck/formatter.py#L133)
+#### Arguments
+
+- `packages` *list[PackageCompat]* - list of PackageCompats to format.
+
+#### Returns
+
+- `str` - string to send to specified output in ansi format
+
+#### Signature
 
 ```python
-def ansi(packages: list[PackageCompat], heading: str | None = None) -> str:
+def ansi(packages: list[PackageCompat]) -> str:
+    ...
 ```
 
-Format to ansi.
+#### See also
+
+- [PackageCompat](./types.md#packagecompat)
+
+
+
+## markdown
+
+[Show source in formatter.py:91](../../../licensecheck/formatter.py#L91)
+
+Format to markdown
 
 #### Arguments
 
-- `packages` *list[PackageCompat]* - PackageCompats to format
-- `heading` *str, optional* - Optional heading to include. Defaults to None.
+- `packages` *list[PackageCompat]* - list of PackageCompats to format.
 
 #### Returns
 
-- `str` - String to write to a file of stdout
+- `str` - string to send to specified output in markdown format
+
+#### Signature
+
+```python
+def markdown(packages: list[PackageCompat]) -> str:
+    ...
+```
 
 #### See also
 
-- [PackageCompat](types.md#packagecompat)
+- [PackageCompat](./types.md#packagecompat)
 
-## csv
 
-[[find in source code]](../../../licensecheck/formatter.py#L91)
 
-```python
-def csv(packages: list[PackageCompat], heading: str | None = None) -> str:
-```
+## plainText
+
+[Show source in formatter.py:79](../../../licensecheck/formatter.py#L79)
 
-Format to CSV.
+Format to plain text
 
 #### Arguments
 
-- `packages` *list[PackageCompat]* - PackageCompats to format
-- `heading` *str, optional* - Optional heading to include. Defaults to None.
+- `packages` *list[PackageCompat]* - list of PackageCompats to format.
 
 #### Returns
 
-- `str` - String to write to a file of stdout
+- `str` - string to send to specified output in plain text format
+
+#### Signature
+
+```python
+def plainText(packages: list[PackageCompat]) -> str:
+    ...
+```
 
 #### See also
 
-- [PackageCompat](types.md#packagecompat)
+- [PackageCompat](./types.md#packagecompat)
 
-## json
 
-[[find in source code]](../../../licensecheck/formatter.py#L71)
 
-```python
-def json(packages: list[PackageCompat], heading: str | None = None) -> str:
-```
+## raw
+
+[Show source in formatter.py:127](../../../licensecheck/formatter.py#L127)
 
-Format to Json.
+Format to raw json
 
 #### Arguments
 
-- `packages` *list[PackageCompat]* - PackageCompats to format
-- `heading` *str, optional* - Optional heading to include. Defaults to None.
+- `packages` *list[PackageCompat]* - list of PackageCompats to format.
 
 #### Returns
 
-- `str` - String to write to a file of stdout
+- `str` - string to send to specified output in raw json format
+
+#### Signature
+
+```python
+def raw(packages: list[PackageCompat]) -> str:
+    ...
+```
 
 #### See also
 
-- [PackageCompat](types.md#packagecompat)
+- [PackageCompat](./types.md#packagecompat)
 
-## markdown
 
-[[find in source code]](../../../licensecheck/formatter.py#L32)
 
-```python
-def markdown(
-    packages: list[PackageCompat],
-    heading: str | None = None,
-) -> str:
-```
+## rawCsv
 
-Format to Markdown.
+[Show source in formatter.py:139](../../../licensecheck/formatter.py#L139)
+
+Format to raw csv
 
 #### Arguments
 
-- `packages` *list[PackageCompat]* - PackageCompats to format
-- `heading` *str, optional* - Optional heading to include. Defaults to None.
+- `packages` *list[PackageCompat]* - list of PackageCompats to format.
 
 #### Returns
 
-- `str` - String to write to a file of stdout
+- `str` - string to send to specified output in raw csv format
+
+#### Signature
+
+```python
+def rawCsv(packages: list[PackageCompat]) -> str:
+    ...
+```
 
 #### See also
 
-- [PackageCompat](types.md#packagecompat)
+- [PackageCompat](./types.md#packagecompat)
 
-## simple
 
-[[find in source code]](../../../licensecheck/formatter.py#L186)
 
-```python
-def simple(packages: list[PackageCompat]) -> str:
-```
+## stripAnsi
 
-Format to plain text.
+[Show source in formatter.py:38](../../../licensecheck/formatter.py#L38)
+
+Strip ansi codes from a given string
 
 #### Arguments
 
-- `packages` *list[PackageCompat]* - PackageCompats to format
+- `string` *str* - string to strip codes from
 
 #### Returns
 
-- `str` - String to write to a file of stdout
+- `str` - plaintext, utf-8 string (safe for writing to files)
+
+#### Signature
+
+```python
+def stripAnsi(string: str) -> str:
+    ...
+```
 
-#### See also
 
-- [PackageCompat](types.md#packagecompat)

documentation/reference/licensecheck/formatter.md

@@ -1,26 +1,18 @@
 # Get Deps
 
-> Auto-generated documentation for [licensecheck.get_deps](../../../licensecheck/get_deps.py) module.
-
-Get a list of packages with package compatibility.
+[Licensecheck Index](../README.md#licensecheck-index) /
+[Licensecheck](./index.md#licensecheck) /
+Get Deps
 
-- [Licensecheck](../README.md#licensecheck-index) / [Modules](../MODULES.md#licensecheck-modules) / [Licensecheck](index.md#licensecheck) / Get Deps
-    - [getDepsWLicenses](#getdepswlicenses)
-    - [getReqs](#getreqs)
+> Auto-generated documentation for [licensecheck.get_deps](../../../licensecheck/get_deps.py) module.
 
-## getDepsWLicenses
+- [Get Deps](#get-deps)
+  - [getDepsWithLicenses](#getdepswithlicenses)
+  - [getReqs](#getreqs)
 
-[[find in source code]](../../../licensecheck/get_deps.py#L85)
+## getDepsWithLicenses
 
-```python
-def getDepsWLicenses(
-    using: str,
-    ignorePackages: list[str],
-    failPackages: list[str],
-    ignoreLicenses: list[str],
-    failLicenses: list[str],
-) -> list[PackageCompat]:
-```
+[Show source in get_deps.py:90](../../../licensecheck/get_deps.py#L90)
 
 Get a list of dependencies with licenses and determin license compatibility.
 
@@ -36,24 +28,51 @@ Get a list of dependencies with licenses and determin license compatibility.
 
 - `list[PackageCompat]` - list of packagecompat types: dependency info + licence compat
 
+#### Signature
+
+```python
+def getDepsWithLicenses(
+    using: str,
+    ignorePackages: list[str],
+    failPackages: list[str],
+    ignoreLicenses: list[str],
+    failLicenses: list[str],
+) -> list[PackageCompat]:
+    ...
+```
+
 #### See also
 
-- [PackageCompat](types.md#packagecompat)
+- [PackageCompat](./types.md#packagecompat)
+
+
 
 ## getReqs
 
-[[find in source code]](../../../licensecheck/get_deps.py#L41)
+[Show source in get_deps.py:41](../../../licensecheck/get_deps.py#L41)
+
+Get requirements for the end user project/ lib.
 
 ```python
-def getReqs(using: str) -> list[str]:
+>>> getReqs("poetry")
+>>> getReqs("poetry:dev")
+>>> getReqs("requirements")
+>>> getReqs("requirements:requirements.txt;requirements-dev.txt")
 ```
 
-Get requirements for the end user project/ lib.
-
 #### Arguments
 
-- `using` *str* - use requirements or poetry
+- `using` *str* - use requirements or poetry.
 
 #### Returns
 
 - `list[str]` - list of requirement packages
+
+#### Signature
+
+```python
+def getReqs(using: str) -> list[str]:
+    ...
+```
+
+