Skip to content

Commit 78ec912

Browse files
committed
Generate a license report
1 parent 71ed797 commit 78ec912

File tree

7 files changed

+582
-9
lines changed

7 files changed

+582
-9
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -361,17 +361,33 @@ Licensing for the project is defined in:
361361

362362
This project uses a common permissive license, the MIT license.
363363

364-
You may also want to list the licenses of all the packages that your Python project depends on.
365-
To automatically list the licenses for all dependencies in (and their transitive dependencies)
366-
using [pip-licenses-cli](https://github.com/stefan6419846/pip-licenses-cli):
364+
A license report of all third party packages and their transitive dependencies is generated and
365+
built into the user guide. This allows application developers to comply with these licenses, which
366+
require that the license be included when the library is shipped to end users.
367+
368+
To automatically list the licenses for all dependencies and regenerate the license report using
369+
[pip-licenses-cli](https://github.com/stefan6419846/pip-licenses-cli):
367370

368371
```shell
369372
$ uv run nox -s licenses
370373
...
374+
nox > pip-licenses
371375
Name Version License
372-
Pygments 2.19.1 BSD License
373-
click 8.1.8 BSD License
374-
markdown-it-py 3.0.0 MIT License
376+
Pygments 2.19.2 BSD License
377+
click 8.3.0 BSD-3-Clause
378+
markdown-it-py 4.0.0 MIT License
379+
mdurl 0.1.2 MIT License
380+
rich 14.2.0 MIT License
381+
shellingham 1.5.4 ISC License (ISCL)
382+
typer-slim 0.20.0 MIT License
383+
typing_extensions 4.15.0 PSF-2.0
384+
nox > pip-licenses --summary
385+
Count License
386+
1 BSD License
387+
1 BSD-3-Clause
388+
1 ISC License (ISCL)
389+
4 MIT License
390+
1 PSF-2.0
375391
```
376392

377393
# Container

0 commit comments

Comments
 (0)