generated from nexB/skeleton
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bump version and prepare release 0.2.0
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
- Loading branch information
1 parent
6f34223
commit 8deb22d
Showing
7 changed files
with
96 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
The following organizations or individuals have contributed to this repo: | ||
|
||
- | ||
- Tushar Goel @TG1999 | ||
- Philippe Ombredanne @pombredanne | ||
- nexB Inc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,75 @@ | ||
Go-Inspector | ||
go-inspector | ||
================================ | ||
|
||
- To enable the GoReSym plugin, first you need to install goresym from https://github.com/mandiant/GoReSym/releases/download/v2.6.4/GoReSym.zip | ||
- Unzip the GoReSym.zip, extract goresym for linux and add it in src/go_inspector/bin. | ||
- then change it to executable ```chmod u+x src/go_inspector/bin/GoReSym_lin``` | ||
- Install requirements and dependencies using ```make dev``` | ||
- Use ```scancode --json-pp - --go-symbol <PATH> --verbose``` to get debug symbols. | ||
go-inspector is a utility to extract dependencies and symbols from Go binaries. | ||
It is desigend to work as a ScanCode Toolkit plugin. | ||
|
||
To install and use: | ||
|
||
How to generate test binaries | ||
============================ | ||
- Run ``pip install go-inspector`` | ||
- Use with ``scancode --json-pp - --go-symbol --verbose <PATH to a tree or file with Go binaries>`` | ||
|
||
- Run `go tool dist list` to get all possible pairs of OSes and arches to compile the binary. | ||
- Then use a OS/arch pair like this ``GOOS=<OS> GOARCH=<arch> go build -o ./tests/data/app_exe ./tests/data/main.go`` | ||
to get compiled binary. | ||
The JSON output will contain various dependencies and symbols found in Go binaries if any. | ||
|
||
|
||
- License: Apache-2.0 AND MIT AND BSD-3-Clause WITH LicenRef-scancode-google-patent-license-golang | ||
- Copyright (c) nexB Inc., Mandiant, The Go Authors, Elliot Chance and others | ||
- Homepage: https://github.com/nexB/go-inspector/ | ||
|
||
See the src/go_inspector/bin for detailed license and credits for bundled third-party packages. | ||
|
||
|
||
Development | ||
---------------- | ||
|
||
- Install requirements and dependencies using ``make dev`` | ||
- Then ``source venv/bin/activate`` | ||
|
||
Testing: | ||
|
||
- To run tests: ``pytest -vvs`` | ||
- To regen test fixtures: ``SCANCODE_REGEN_TEST_FIXTURES=yes pytest -vvs`` | ||
- To update the bundled GoReSym, see src/bin/update.sh | ||
|
||
|
||
How to re-generate test binaries | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
These are compiled (and committed) from code in tests/data/basic : | ||
|
||
- Run ``go tool dist list`` to get all possible pairs of OSes and arches to compile the binary. | ||
- Then build a OS/arch pair like this to get compiled binaries: | ||
``GOOS=<OS> GOARCH=<arch> go build -o ./tests/data/basic/app_<OS>_exe ./tests/data/main.go`` | ||
- Make a copy and run strip of the Linux executable as "app_lin_exe_stripped" | ||
|
||
|
||
Funding and sponsoring | ||
--------------------------- | ||
|
||
This project is funded in part through: | ||
|
||
- NGI0 Entrust https://nlnet.nl/entrust, a fund established by NLnet with | ||
financial support from the European Commission's Next Generation Internet https://ngi.eu program. | ||
Learn more at the NLnet project page https://nlnet.nl/purl2all. | ||
|
||
|nlnet| and |ngi0entrust| | ||
|
||
- Support from nexB Inc. |nexb| | ||
|
||
- Generous support from users like you! | ||
|
||
|
||
.. |nlnet| image:: https://nlnet.nl/logo/banner.png | ||
:target: https://nlnet.nl | ||
:width: 20% | ||
:alt: NLnet foundation logo | ||
|
||
.. |ngi0entrust| image:: https://nlnet.nl/image/logos/NGI0_tag.svg | ||
:target: https://nlnet.nl/entrust | ||
:width: 20% | ||
:alt: NGI Zero Logo | ||
|
||
.. |nexb| image:: https://nexb.com/wp-content/uploads/2022/04/nexB.svg | ||
:target: https://nexb.com | ||
:width: 20% | ||
:alt: nexB logo |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1 @@ | ||
|
||
__version__ = "0.1.0" | ||
__version__ = "0.2.0" |