Skip to content

Commit ccda0d1

Browse files
committed
improve readme
1 parent 596cc54 commit ccda0d1

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ Paranoid:
3737
for the package to be considered compliant. A package is still
3838
compliant if present in the authorized packages list.
3939

40+
Assumption
41+
==========
42+
The tool requires to be installed in the same python (virtual) environment as the packages. This, because it uses
43+
``pkg_resources`` to access the packages resources and thus, their licenses information.
44+
4045
How to install
4146
==============
4247

@@ -130,6 +135,19 @@ If some dependencies are unknown or are not matching the strategy, the output wi
130135
dependency:
131136
feedparser
132137

138+
139+
Using liccheck with pre-commit
140+
==============================
141+
142+
Add this to your .pre-commit-config.yaml:
143+
::
144+
145+
- repo: https://github.com/dhatim/python-license-check
146+
rev: master
147+
hooks:
148+
- id: liccheck
149+
language: system
150+
133151
Contributing
134152
============
135153

0 commit comments

Comments
 (0)