more docs and code qa

Author: FredHappyface

.gitignore

@@ -1,6 +1,7 @@
 !test
 uv.lock
 profile.*
+ignore/**
 
 # DepHell stuff
 poetry.lock

CHANGELOG.md

@@ -3,6 +3,11 @@
 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).
 
+## 2025.1.0 - 2025/03/18
+
+- Updated internal machineary
+- Separate `--extras` and `--groups`
+
 ## 2025.0.1 - 2025/03/16
 
 - update the cli interface to remove some confusing functionality

README.md

@@ -2,18 +2,156 @@
 
 ## Basic Example Use
 
-
+Per the main README... More examples are available [here](examples.md)
+
+### Using pyproject.toml (default if not piping input)
+
+```txt
+>> licensecheck
+
+...
+							  List Of Packages
+┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Compatible ┃ Package             ┃ License(s)                            ┃
+┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ ✔          │ appdirs             │ MIT LICENSE                           │
+│ ✔          │ attrs               │ MIT LICENSE                           │
+│ ✔          │ boolean-py          │ BSD-2-CLAUSE                          │
+│ ✔          │ cattrs              │ MIT LICENSE                           │
+│ ✔          │ certifi             │ MOZILLA PUBLIC LICENSE 2.0 _MPL 2.0_  │
+│ ✔          │ charset-normalizer  │ MIT LICENSE                           │
+│ ✔          │ colorama            │ BSD LICENSE                           │
+│ ✔          │ fhconfparser        │ MIT LICENSE                           │
+│ ✔          │ idna                │ BSD LICENSE                           │
+│ ✔          │ license-expression  │ APACHE-2.0                            │
+│ ✔          │ loguru              │ MIT LICENSE                           │
+│ ✔          │ markdown            │ BSD LICENSE                           │
+│ ✔          │ markdown-it-py      │ MIT LICENSE                           │
+│ ✔          │ mdurl               │ MIT LICENSE                           │
+│ ✔          │ packaging           │ APACHE SOFTWARE LICENSE;; BSD LICENSE │
+│ ✔          │ platformdirs        │ MIT LICENSE                           │
+│ ✔          │ pygments            │ BSD LICENSE                           │
+│ ✔          │ requests            │ APACHE SOFTWARE LICENSE               │
+│ ✔          │ requests-cache      │ BSD LICENSE                           │
+│ ✔          │ requirements-parser │ APACHE SOFTWARE LICENSE               │
+│ ✔          │ rich                │ MIT LICENSE                           │
+│ ✔          │ setuptools          │ MIT LICENSE                           │
+│ ✔          │ six                 │ MIT LICENSE                           │
+│ ✔          │ tomli               │ MIT LICENSE                           │
+│ ✔          │ types-setuptools    │ APACHE SOFTWARE LICENSE               │
+│ ✔          │ url-normalize       │ MIT LICENSE                           │
+│ ✔          │ urllib3             │ MIT LICENSE                           │
+│ ✔          │ uv                  │ APACHE SOFTWARE LICENSE;; MIT LICENSE │
+│ ✔          │ win32-setctime      │ MIT LICENSE                           │
+└────────────┴─────────────────────┴───────────────────────────────────────┘
+
+```
+
+
+
+### Use csv format
+
+```csv
+>>> licensecheck  --only-licenses mit apache --show-only-failing -f csv
+name,version,size,homePage,author,license,licenseCompat,errorCode,namever
+Markdown,3.7,361400,UNKNOWN,"Manfred Stienstra, Yuri Takhteyev",BSD LICENSE,False,0,Markdown-3.7
+Pygments,2.19.1,4508396,UNKNOWN,UNKNOWN,BSD LICENSE,False,0,Pygments-2.19.1
+boolean.py,4.0,109354,https://github.com/bastikr/boolean.py,Sebastian Kraemer,BSD-2-CLAUSE,False,0,boolean.py-4.0
+certifi,2025.1.31,305559,https://github.com/certifi/python-certifi,Kenneth Reitz,MOZILLA PUBLIC LICENSE 2.0 _MPL 2.0_,False,0,certifi-2025.1.31
+colorama,0.4.6,76299,UNKNOWN,UNKNOWN,BSD LICENSE,False,0,colorama-0.4.6
+idna,3.10,349141,UNKNOWN,UNKNOWN,BSD LICENSE,False,0,idna-3.10
+requests-cache,1.2.1,174099,https://github.com/requests-cache/requests-cache,Roman Haritonov,BSD LICENSE,False,0,requests-cache-1.2.1
+```
+
+
+### Groups
+
+```txt
+uv run licensecheck  --only-licenses mit apache --show-only-failing -g dev
+
+...
+
+							List Of Packages
+┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Compatible ┃ Package           ┃ License(s)                           ┃
+┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ ✖          │ authlib           │ BSD LICENSE                          │
+│ ✖          │ boolean-py        │ BSD-2-CLAUSE                         │
+│ ✖          │ certifi           │ MOZILLA PUBLIC LICENSE 2.0 _MPL 2.0_ │
+│ ✖          │ click             │ BSD LICENSE                          │
+│ ✖          │ colorama          │ BSD LICENSE                          │
+│ ✖          │ filelock          │ THE UNLICENSE _UNLICENSE_            │
+│ ✖          │ idna              │ BSD LICENSE                          │
+│ ✖          │ jinja2            │ BSD LICENSE                          │
+│ ✖          │ joblib            │ BSD LICENSE                          │
+...
+```
 
 
 ## Supported tools/ standards
 
 Licensecheck supports a broad range of different tools and workflows. Though please note that
-for some of these tools, behaviour may differ from what is expected
+for some of these tools, behaviour may differ from what is expected. We use `uv` for the dependency
+resolution due to the good performance across projects, with a fallback to a native parser in case of
+an error, which will be logged
+
+Note that `uv` supports requirements.in files. If a pyproject.toml, setup.py, or setup.cfg file is
+provided, `uv` will extract the requirements for the relevant project. In testing this seems to have
+broad support for various workflows
+
+In addition to this, `licensecheck` will attempt to determine your project license from a `pyproject.toml` or
+a `setup.cfg`
 
 | Name of tool | Supported | Notes |
 | ------------ | --------- | ----- |
-| Poetry 2.x   | ✔         | ???   |
-
+| Poetry 2.x   | ✔         |    |
+| Poetry 1.x   | ✔         |    |
+| uv   | ✔         |    |
+| flit   | ✔         |    |
+
+
+### 'legacy' setup.cfg example
+
+```ini
+[metadata]
+classifiers =
+    License :: OSI Approved :: MIT License
+    Programming Language :: Python :: 3.8
+license = MIT
+
+```
+
+### Poetry example
+
+```toml
+[tool.poetry]
+name = "mypackage"
+version = "0.1.0"
+description = "A simple Python package"
+license = "MIT"
+authors = ["Author <[email protected]>"]
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.8"
+]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+
+```
+
+### Flit example
+
+```toml
+[tool.flit.metadata]
+module = "mypackage"
+description = "A simple Python package"
+license = "MIT"
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.8"
+]
+```
 
 ## Resolve all deps