|
1 |
| -A Simple Python Project Skeleton |
| 1 | +rust-inspector |
2 | 2 | ================================
|
3 |
| -This repo attempts to standardize the structure of the Python-based project's |
4 |
| -repositories using modern Python packaging and configuration techniques. |
5 |
| -Using this `blog post`_ as inspiration, this repository serves as the base for |
6 |
| -all new Python projects and is mergeable in existing repositories as well. |
7 | 3 |
|
8 |
| -.. _blog post: https://blog.jaraco.com/a-project-skeleton-for-python-projects/ |
| 4 | +rust-inspector is a utility to extract dependencies and symbols from Rust binaries. |
| 5 | +It is designed to work as a ScanCode Toolkit plugin and integrated in ScanCode.io |
| 6 | +pipelines. |
9 | 7 |
|
| 8 | +To install and use: |
10 | 9 |
|
11 |
| -Usage |
12 |
| -===== |
| 10 | +- Run ``pip install rust-inspector`` |
| 11 | +- Use with ``scancode --json-pp - --rust-symbol --verbose <PATH to a tree or file with Rust binaries>`` |
13 | 12 |
|
14 |
| -A brand new project |
15 |
| -------------------- |
16 |
| -.. code-block:: bash |
| 13 | +The JSON output will contain binary symbols found in Rust binaries if any. |
17 | 14 |
|
18 |
| - git init my-new-repo |
19 |
| - cd my-new-repo |
20 |
| - git pull git@github.com:nexB/skeleton |
| 15 | +A Go compiler is required to build go-inspector. Install Go from |
| 16 | +https://go.dev/doc/install or from a package manager. |
21 | 17 |
|
22 |
| - # Create the new repo on GitHub, then update your remote |
23 |
| - git remote set-url origin git@github.com:nexB/your-new-repo.git |
| 18 | +- License: Apache-2.0 AND MIT |
| 19 | +- Copyright (c) nexB Inc., AboutCode, OWASP Foundation and others. |
| 20 | +- Homepage: https://github.com/aboutcode-org/rust-inspector |
24 | 21 |
|
25 |
| -From here, you can make the appropriate changes to the files for your specific project. |
| 22 | +Development |
| 23 | +---------------- |
26 | 24 |
|
27 |
| -Update an existing project |
28 |
| ---------------------------- |
29 |
| -.. code-block:: bash |
| 25 | +- Install requirements and dependencies using ``./configure --clean && ./configure --dev`` |
| 26 | +- Then ``source venv/bin/activate`` |
30 | 27 |
|
31 |
| - cd my-existing-project |
32 |
| - git remote add skeleton git@github.com:nexB/skeleton |
33 |
| - git fetch skeleton |
34 |
| - git merge skeleton/main --allow-unrelated-histories |
| 28 | +Testing: |
35 | 29 |
|
36 |
| -This is also the workflow to use when updating the skeleton files in any given repository. |
| 30 | +- To run tests: ``pytest -vvs`` |
| 31 | +- To regen test fixtures: ``SCANCODE_REGEN_TEST_FIXTURES=yes pytest -vvs`` |
37 | 32 |
|
38 |
| -More usage instructions can be found in ``docs/skeleton-usage.rst``. |
| 33 | +Acknowledgements, Funding, Support and Sponsoring |
| 34 | +-------------------------------------------------------- |
39 | 35 |
|
| 36 | +This project is funded, supported and sponsored by: |
40 | 37 |
|
41 |
| -Release Notes |
42 |
| -============= |
| 38 | +- Generous support and contributions from users like you! |
| 39 | +- the European Commission NGI programme |
| 40 | +- the NLnet Foundation |
| 41 | +- the Swiss State Secretariat for Education, Research and Innovation (SERI) |
| 42 | +- Google, including the Google Summer of Code and the Google Seasons of Doc programmes |
| 43 | +- Mercedes-Benz Group |
| 44 | +- Microsoft and Microsoft Azure |
| 45 | +- AboutCode ASBL |
| 46 | +- nexB Inc. |
43 | 47 |
|
44 |
| -- 2023-07-18: |
45 |
| - - Add macOS-13 job in azure-pipelines.yml |
| 48 | +This project also uses some functions from other packages: |
46 | 49 |
|
47 |
| -- 2022-03-04: |
48 |
| - - Synchronize configure and configure.bat scripts for sanity |
49 |
| - - Update CI operating system support with latest Azure OS images |
50 |
| - - Streamline utility scripts in etc/scripts/ to create, fetch and manage third-party dependencies |
51 |
| - There are now fewer scripts. See etc/scripts/README.rst for details |
| 50 | +- blint (https://github.com/owasp-dep-scan/blint) |
| 51 | +- symbolic (https://pypi.org/project/symbolic/) |
| 52 | +- lief (https://pypi.org/project/lief/) |
52 | 53 |
|
53 |
| -- 2021-09-03: |
54 |
| - - ``configure`` now requires pinned dependencies via the use of ``requirements.txt`` and ``requirements-dev.txt`` |
55 |
| - - ``configure`` can now accept multiple options at once |
56 |
| - - Add utility scripts from scancode-toolkit/etc/release/ for use in generating project files |
57 |
| - - Rename virtual environment directory from ``tmp`` to ``venv`` |
58 |
| - - Update README.rst with instructions for generating ``requirements.txt`` and ``requirements-dev.txt``, |
59 |
| - as well as collecting dependencies as wheels and generating ABOUT files for them. |
60 | 54 |
|
61 |
| -- 2021-05-11: |
62 |
| - - Adopt new configure scripts from ScanCode TK that allows correct configuration of which Python version is used. |
| 55 | +|europa| |dgconnect| |
| 56 | + |
| 57 | +|ngi| |nlnet| |
| 58 | + |
| 59 | +|aboutcode| |nexb| |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | +This project was funded through the NGI0 Entrust Fund, a fund established by NLnet with financial |
| 64 | +support from the European Commission's Next Generation Internet programme, under the aegis of DG |
| 65 | +Communications Networks, Content and Technology under grant agreement No 101069594. |
| 66 | + |
| 67 | +|ngizeroentrust| https://nlnet.nl/project/Back2source/ |
| 68 | + |
| 69 | + |
| 70 | +This project was funded through the NGI0 Core Fund, a fund established by NLnet with financial |
| 71 | +support from the European Commission's Next Generation Internet programme, under the aegis of DG |
| 72 | +Communications Networks, Content and Technology under grant agreement No 101092990. |
| 73 | + |
| 74 | +|ngizerocore| https://nlnet.nl/project/Back2source-next/ |
| 75 | + |
| 76 | + |
| 77 | +This project was funded through the NGI0 Entrust Fund, a fund established by NLnet with financial |
| 78 | +support from the European Commission's Next Generation Internet programme, under the aegis of DG |
| 79 | +Communications Networks, Content and Technology under grant agreement No 101069594. |
| 80 | + |
| 81 | +|ngizeroentrust| https://nlnet.nl/project/purl2all/ |
| 82 | + |
| 83 | + |
| 84 | + |
| 85 | +.. |nlnet| image:: https://nlnet.nl/logo/banner.png |
| 86 | + :target: https://nlnet.nl |
| 87 | + :height: 50 |
| 88 | + :alt: NLnet foundation logo |
| 89 | + |
| 90 | +.. |ngi| image:: https://ngi.eu/wp-content/uploads/thegem-logos/logo_8269bc6efcf731d34b6385775d76511d_1x.png |
| 91 | + :target: https://ngi.eu35 |
| 92 | + :height: 50 |
| 93 | + :alt: NGI logo |
| 94 | + |
| 95 | +.. |nexb| image:: https://nexb.com/wp-content/uploads/2022/04/nexB.svg |
| 96 | + :target: https://nexb.com |
| 97 | + :height: 30 |
| 98 | + :alt: nexB logo |
| 99 | + |
| 100 | +.. |europa| image:: https://ngi.eu/wp-content/uploads/sites/77/2017/10/bandiera_stelle.png |
| 101 | + :target: http://ec.europa.eu/index_en.htm |
| 102 | + :height: 40 |
| 103 | + :alt: Europa logo |
| 104 | + |
| 105 | +.. |aboutcode| image:: https://aboutcode.org/wp-content/uploads/2023/10/AboutCode.svg |
| 106 | + :target: https://aboutcode.org/ |
| 107 | + :height: 30 |
| 108 | + :alt: AboutCode logo |
| 109 | + |
| 110 | +.. |swiss| image:: https://www.sbfi.admin.ch/sbfi/en/_jcr_content/logo/image.imagespooler.png/1493119032540/logo.png |
| 111 | + :target: https://www.sbfi.admin.ch/sbfi/en/home/seri/seri.html |
| 112 | + :height: 40 |
| 113 | + :alt: Swiss logo |
| 114 | + |
| 115 | +.. |dgconnect| image:: https://commission.europa.eu/themes/contrib/oe_theme/dist/ec/images/logo/positive/logo-ec--en.svg |
| 116 | + :target: https://commission.europa.eu/about-european-commission/departments-and-executive-agencies/communications-networks-content-and-technology_en |
| 117 | + :height: 40 |
| 118 | + :alt: EC DG Connect logo |
| 119 | + |
| 120 | +.. |ngizerocore| image:: https://nlnet.nl/image/logos/NGI0_tag.svg |
| 121 | + :target: https://nlnet.nl/core |
| 122 | + :height: 40 |
| 123 | + :alt: NGI Zero Core Logo |
| 124 | + |
| 125 | +.. |ngizerocommons| image:: https://nlnet.nl/image/logos/NGI0_tag.svg |
| 126 | + :target: https://nlnet.nl/commonsfund/ |
| 127 | + :height: 40 |
| 128 | + :alt: NGI Zero Commons Logo |
| 129 | + |
| 130 | +.. |ngizeropet| image:: https://nlnet.nl/image/logos/NGI0PET_tag.svg |
| 131 | + :target: https://nlnet.nl/PET |
| 132 | + :height: 40 |
| 133 | + :alt: NGI Zero PET logo |
| 134 | + |
| 135 | +.. |ngizeroentrust| image:: https://nlnet.nl/image/logos/NGI0Entrust_tag.svg |
| 136 | + :target: https://nlnet.nl/entrust |
| 137 | + :height: 38 |
| 138 | + :alt: NGI Zero Entrust logo |
| 139 | + |
| 140 | +.. |ngiassure| image:: https://nlnet.nl/image/logos/NGIAssure_tag.svg |
| 141 | + :target: https://nlnet.nl/image/logos/NGIAssure_tag.svg |
| 142 | + :height: 32 |
| 143 | + :alt: NGI Assure logo |
| 144 | + |
| 145 | +.. |ngidiscovery| image:: https://nlnet.nl/image/logos/NGI0Discovery_tag.svg |
| 146 | + :target: https://nlnet.nl/discovery/ |
| 147 | + :height: 40 |
| 148 | + :alt: NGI Discovery logo |
0 commit comments