Skip to content

Commit f3839c3

Browse files
committed
Enable users to use installed licenses in scans
This allows users to use licenses that they install via wheels in license scans. It also adds a sample package containing an external license that can be used to manually verify expected behavior.
1 parent cf87918 commit f3839c3

File tree

12 files changed

+464
-0
lines changed

12 files changed

+464
-0
lines changed

src/licensedcode/cache.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,7 @@ def build_index(
202202
else:
203203
licenses_db = load_licenses(licenses_data_dir=licenses_data_dir)
204204

205+
# TODO: can we assume that people won't upload rules? or should I extend the functionality to additional rules too?
205206
if additional_directories:
206207
# if we have additional directories, extract the rules from them
207208
additional_rule_dirs = get_rule_dirs(additional_dirs=additional_directories)
@@ -362,7 +363,16 @@ def populate_cache(force=False, index_all_languages=False, additional_directorie
362363
"""
363364
Load or build and cache a LicenseCache. Return None.
364365
"""
366+
from licensedcode.models import get_paths_to_installed_licenses
365367
global _LICENSE_CACHE
368+
369+
# include installed licenses
370+
if not additional_directories:
371+
additional_directories = get_paths_to_installed_licenses()
372+
else:
373+
# additional_directories is originally a tuple
374+
additional_directories = list(additional_directories) + get_paths_to_installed_licenses()
375+
366376
if need_cache_rebuild(additional_directories):
367377
force = True
368378
if force or not _LICENSE_CACHE:

src/licensedcode/models.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -794,6 +794,19 @@ def get_rule_dirs(
794794
return [f"{str(Path(path).absolute())}/rules" for path in additional_dirs]
795795

796796

797+
def get_paths_to_installed_licenses():
798+
from importlib_metadata import entry_points
799+
from plugincode.location_provider import get_location
800+
installed_plugins = entry_points(group='scancode_location_provider')
801+
paths = []
802+
for plugin in installed_plugins:
803+
if plugin.name.startswith('licenses'):
804+
# get path to directory of licenses
805+
location_key = f"{plugin.name}.licenses"
806+
paths.append(get_location(location_key))
807+
return paths
808+
809+
797810
def load_licenses_from_multiple_dirs(
798811
license_directories,
799812
with_deprecated=False,
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/build/
2+
/dist/
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
graft src
2+
graft thirdparty
3+
4+
include setup.*
5+
include *.rst
6+
include *LICENSE*
7+
include *NOTICE*
Lines changed: 254 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,254 @@
1+
GNU GENERAL PUBLIC LICENSE
2+
Version 1, February 1989
3+
4+
Copyright (C) 1989 Free Software Foundation, Inc.
5+
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
6+
7+
Everyone is permitted to copy and distribute verbatim copies
8+
of this license document, but changing it is not allowed.
9+
10+
Preamble
11+
12+
The license agreements of most software companies try to keep users
13+
at the mercy of those companies. By contrast, our General Public
14+
License is intended to guarantee your freedom to share and change free
15+
software--to make sure the software is free for all its users. The
16+
General Public License applies to the Free Software Foundation's
17+
software and to any other program whose authors commit to using it.
18+
You can use it for your programs, too.
19+
20+
When we speak of free software, we are referring to freedom, not
21+
price. Specifically, the General Public License is designed to make
22+
sure that you have the freedom to give away or sell copies of free
23+
software, that you receive source code or can get it if you want it,
24+
that you can change the software or use pieces of it in new free
25+
programs; and that you know you can do these things.
26+
27+
To protect your rights, we need to make restrictions that forbid
28+
anyone to deny you these rights or to ask you to surrender the rights.
29+
These restrictions translate to certain responsibilities for you if you
30+
distribute copies of the software, or if you modify it.
31+
32+
For example, if you distribute copies of a such a program, whether
33+
gratis or for a fee, you must give the recipients all the rights that
34+
you have. You must make sure that they, too, receive or can get the
35+
source code. And you must tell them their rights.
36+
37+
We protect your rights with two steps: (1) copyright the software, and
38+
(2) offer you this license which gives you legal permission to copy,
39+
distribute and/or modify the software.
40+
41+
Also, for each author's protection and ours, we want to make certain
42+
that everyone understands that there is no warranty for this free
43+
software. If the software is modified by someone else and passed on, we
44+
want its recipients to know that what they have is not the original, so
45+
that any problems introduced by others will not reflect on the original
46+
authors' reputations.
47+
48+
The precise terms and conditions for copying, distribution and
49+
modification follow.
50+
51+
52+
GNU GENERAL PUBLIC LICENSE
53+
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
54+
55+
0. This License Agreement applies to any program or other work which
56+
contains a notice placed by the copyright holder saying it may be
57+
distributed under the terms of this General Public License. The
58+
"Program", below, refers to any such program or work, and a "work based
59+
on the Program" means either the Program or any work containing the
60+
Program or a portion of it, either verbatim or with modifications. Each
61+
licensee is addressed as "you".
62+
63+
1. You may copy and distribute verbatim copies of the Program's source
64+
code as you receive it, in any medium, provided that you conspicuously and
65+
appropriately publish on each copy an appropriate copyright notice and
66+
disclaimer of warranty; keep intact all the notices that refer to this
67+
General Public License and to the absence of any warranty; and give any
68+
other recipients of the Program a copy of this General Public License
69+
along with the Program. You may charge a fee for the physical act of
70+
transferring a copy.
71+
72+
2. You may modify your copy or copies of the Program or any portion of
73+
it, and copy and distribute such modifications under the terms of Paragraph
74+
1 above, provided that you also do the following:
75+
76+
a) cause the modified files to carry prominent notices stating that
77+
you changed the files and the date of any change; and
78+
79+
b) cause the whole of any work that you distribute or publish, that
80+
in whole or in part contains the Program or any part thereof, either
81+
with or without modifications, to be licensed at no charge to all
82+
third parties under the terms of this General Public License (except
83+
that you may choose to grant warranty protection to some or all
84+
third parties, at your option).
85+
86+
c) If the modified program normally reads commands interactively when
87+
run, you must cause it, when started running for such interactive use
88+
in the simplest and most usual way, to print or display an
89+
announcement including an appropriate copyright notice and a notice
90+
that there is no warranty (or else, saying that you provide a
91+
warranty) and that users may redistribute the program under these
92+
conditions, and telling the user how to view a copy of this General
93+
Public License.
94+
95+
d) You may charge a fee for the physical act of transferring a
96+
copy, and you may at your option offer warranty protection in
97+
exchange for a fee.
98+
99+
Mere aggregation of another independent work with the Program (or its
100+
derivative) on a volume of a storage or distribution medium does not bring
101+
the other work under the scope of these terms.
102+
103+
104+
3. You may copy and distribute the Program (or a portion or derivative of
105+
it, under Paragraph 2) in object code or executable form under the terms of
106+
Paragraphs 1 and 2 above provided that you also do one of the following:
107+
108+
a) accompany it with the complete corresponding machine-readable
109+
source code, which must be distributed under the terms of
110+
Paragraphs 1 and 2 above; or,
111+
112+
b) accompany it with a written offer, valid for at least three
113+
years, to give any third party free (except for a nominal charge
114+
for the cost of distribution) a complete machine-readable copy of the
115+
corresponding source code, to be distributed under the terms of
116+
Paragraphs 1 and 2 above; or,
117+
118+
c) accompany it with the information you received as to where the
119+
corresponding source code may be obtained. (This alternative is
120+
allowed only for noncommercial distribution and only if you
121+
received the program in object code or executable form alone.)
122+
123+
Source code for a work means the preferred form of the work for making
124+
modifications to it. For an executable file, complete source code means
125+
all the source code for all modules it contains; but, as a special
126+
exception, it need not include source code for modules which are standard
127+
libraries that accompany the operating system on which the executable
128+
file runs, or for standard header files or definitions files that
129+
accompany that operating system.
130+
131+
4. You may not copy, modify, sublicense, distribute or transfer the
132+
Program except as expressly provided under this General Public License.
133+
Any attempt otherwise to copy, modify, sublicense, distribute or transfer
134+
the Program is void, and will automatically terminate your rights to use
135+
the Program under this License. However, parties who have received
136+
copies, or rights to use copies, from you under this General Public
137+
License will not have their licenses terminated so long as such parties
138+
remain in full compliance.
139+
140+
5. By copying, distributing or modifying the Program (or any work based
141+
on the Program) you indicate your acceptance of this license to do so,
142+
and all its terms and conditions.
143+
144+
6. Each time you redistribute the Program (or any work based on the
145+
Program), the recipient automatically receives a license from the original
146+
licensor to copy, distribute or modify the Program subject to these
147+
terms and conditions. You may not impose any further restrictions on the
148+
recipients' exercise of the rights granted herein.
149+
150+
151+
7. The Free Software Foundation may publish revised and/or new versions
152+
of the General Public License from time to time. Such new versions will
153+
be similar in spirit to the present version, but may differ in detail to
154+
address new problems or concerns.
155+
156+
Each version is given a distinguishing version number. If the Program
157+
specifies a version number of the license which applies to it and "any
158+
later version", you have the option of following the terms and conditions
159+
either of that version or of any later version published by the Free
160+
Software Foundation. If the Program does not specify a version number of
161+
the license, you may choose any version ever published by the Free Software
162+
Foundation.
163+
164+
8. If you wish to incorporate parts of the Program into other free
165+
programs whose distribution conditions are different, write to the author
166+
to ask for permission. For software which is copyrighted by the Free
167+
Software Foundation, write to the Free Software Foundation; we sometimes
168+
make exceptions for this. Our decision will be guided by the two goals
169+
of preserving the free status of all derivatives of our free software and
170+
of promoting the sharing and reuse of software generally.
171+
172+
NO WARRANTY
173+
174+
9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
175+
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
176+
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
177+
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
178+
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
179+
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
180+
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
181+
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
182+
REPAIR OR CORRECTION.
183+
184+
10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
185+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
186+
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
187+
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
188+
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
189+
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
190+
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
191+
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
192+
POSSIBILITY OF SUCH DAMAGES.
193+
194+
END OF TERMS AND CONDITIONS
195+
196+
197+
Appendix: How to Apply These Terms to Your New Programs
198+
199+
If you develop a new program, and you want it to be of the greatest
200+
possible use to humanity, the best way to achieve this is to make it
201+
free software which everyone can redistribute and change under these
202+
terms.
203+
204+
To do so, attach the following notices to the program. It is safest to
205+
attach them to the start of each source file to most effectively convey
206+
the exclusion of warranty; and each file should have at least the
207+
"copyright" line and a pointer to where the full notice is found.
208+
209+
<one line to give the program's name and a brief idea of what it does.>
210+
Copyright (C) 19yy <name of author>
211+
212+
This program is free software; you can redistribute it and/or modify
213+
it under the terms of the GNU General Public License as published by
214+
the Free Software Foundation; either version 1, or (at your option)
215+
any later version.
216+
217+
This program is distributed in the hope that it will be useful,
218+
but WITHOUT ANY WARRANTY; without even the implied warranty of
219+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
220+
GNU General Public License for more details.
221+
222+
You should have received a copy of the GNU General Public License
223+
along with this program; if not, write to the Free Software
224+
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA
225+
226+
227+
Also add information on how to contact you by electronic and paper mail.
228+
229+
If the program is interactive, make it output a short notice like this
230+
when it starts in an interactive mode:
231+
232+
Gnomovision version 69, Copyright (C) 19xx name of author
233+
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
234+
This is free software, and you are welcome to redistribute it
235+
under certain conditions; type `show c' for details.
236+
237+
The hypothetical commands `show w' and `show c' should show the
238+
appropriate parts of the General Public License. Of course, the
239+
commands you use may be called something other than `show w' and `show
240+
c'; they could even be mouse-clicks or menu items--whatever suits your
241+
program.
242+
243+
You should also get your employer (if you work as a programmer) or your
244+
school, if any, to sign a "copyright disclaimer" for the program, if
245+
necessary. Here a sample; alter the names:
246+
247+
Yoyodyne, Inc., hereby disclaims all copyright interest in the
248+
program `Gnomovision' (a program to direct compilers to make passes
249+
at assemblers) written by James Hacker.
250+
251+
<signature of Ty Coon>, 1 April 1989
252+
Ty Coon, President of Vice
253+
254+
That's all there is to it!
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[metadata]
2+
license_files =
3+
gpl-1.0.LICENSE
4+
5+
[aliases]
6+
release = clean --all bdist_wheel --plat-name manylinux1_x86_64 --python-tag py3
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
#!/usr/bin/env python
2+
# -*- encoding: utf-8 -*-
3+
4+
from glob import glob
5+
from os.path import basename
6+
from os.path import join
7+
from os.path import splitext
8+
9+
from setuptools import find_packages
10+
from setuptools import setup
11+
12+
13+
desc = '''A ScanCode path provider plugin to provide a set of example external licenses that can be installed.'''
14+
15+
setup(
16+
name='licenses_to_install1',
17+
version='1.0',
18+
license=(
19+
'apache-2.0 AND bsd-simplified-darwin AND (bsd-simplified AND public-domain AND '
20+
'bsd-new AND isc AND (bsd-new OR gpl-1.0-plus) AND bsd-original)'
21+
),
22+
description=desc,
23+
long_description=desc,
24+
author='nexB',
25+
author_email='[email protected]',
26+
url='https://github.com/nexB/scancode-plugins',
27+
packages=find_packages('src'),
28+
package_dir={'': 'src'},
29+
include_package_data=True,
30+
py_modules=[splitext(basename(path))[0] for path in glob('src/*.py')],
31+
zip_safe=False,
32+
classifiers=[
33+
# complete classifier list: http://pypi.python.org/pypi?%3Aaction=list_classifiers
34+
'Development Status :: 5 - Production/Stable',
35+
'Intended Audience :: Developers',
36+
'Topic :: Utilities',
37+
],
38+
keywords=[
39+
'open source', 'scancode_licenses',
40+
],
41+
entry_points={
42+
'scancode_location_provider': [
43+
'licenses_to_install1 = licenses_to_install1:LicensesToInstall1Paths',
44+
],
45+
},
46+
)

0 commit comments

Comments
 (0)