Skip to content

Commit 296176a

Browse files
committed
Improve package handling
* Adopt new handler style in plugin * improve utilities * test plugin and package recognition Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
1 parent 0db6803 commit 296176a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+7538
-4690
lines changed

src/packagedcode/README.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,24 @@ Taking Python as a main example a package can exist in multiple forms:
3131
file type with metadata such as Windows DLLs. Additional markers may also include
3232
"namespaces" such as Java or Python imports, C/C++ namespace declarations.
3333

34-
2. **parse and collect the package manifest(s)** metadata. For Python, this means
34+
2. **parse and collect the package datafile or manifest(s)** metadata. For Python, this means
3535
extracting name, version, authorship, declared licensing and declared dependencies as
3636
found in the any of the package descriptor files (e.g. a `setup.py` file,
3737
`requirements` file(s) or any of the `*-dist-info` or `*-egg-info` dir files such as
38-
a `metadata.json`). Other package formats have their own metatada that may be more or
38+
a `metadata.json`). Other package datafile formats have their own metatada that may be more or
3939
less comprehensive in the breadth and depth of information they offer (e.g.
4040
`.nuspec`, `package.json`, `bower.json`, Godeps, etc...). These metadata include the
4141
declared dependencies (and in some cases the fully resolved dependencies too such as
4242
with Gemfile.lock). Finally, all the different packages formats and data are
4343
normalized and stored in a common data structure abstracting the small differences of
4444
naming and semantics that may exists between all the different package formats.
4545

46-
Once collected, these data are then injected in the `packages` section of the scan.
46+
Once collected, these data are then injected in the `package_data` section of a file scan
47+
for each recognized package datafile.
48+
49+
3. **assemble multiple package datafile** as top level packages.
50+
51+
4752

4853
What code in `packagedcode` is not meant to do:
4954

0 commit comments

Comments
 (0)