Merge pull request #2 from aboutcode-org/macho-winpe

Add binary symbols parsing for winpe and macho

Author: AyanSinhaMahapatra

AUTHORS.rst

@@ -1,3 +1,5 @@
 The following organizations or individuals have contributed to this repo:
 
-- 
+- Ayan Sinha Mahapatra @AyanSinhaMahapatra
+- nexB Inc.
+

README.rst

@@ -1,62 +1,145 @@
-A Simple Python Project Skeleton
-================================
-This repo attempts to standardize the structure of the Python-based project's
-repositories using modern Python packaging and configuration techniques.
-Using this `blog post`_ as inspiration, this repository serves as the base for
-all new Python projects and is mergeable in existing repositories as well.
+binary-inspector
+================
 
-.. _blog post: https://blog.jaraco.com/a-project-skeleton-for-python-projects/
+binary-inspector is a utility to extract symbols from various kinds of binaries,
+i.e. ELF, Mach-O, WinPE and other binary formats. It is designed to work as a ScanCode
+Toolkit plugin and integrated in ScanCode.io pipelines.
 
+To install and use:
 
-Usage
-=====
+- Run ``pip install binary-inspector``
+- Use with ``scancode --json-pp - --binary-symbol --verbose <PATH to a tree or file with binaries>``
 
-A brand new project
--------------------
-.. code-block:: bash
+The JSON output will contain binary symbols found in binaries if any.
 
-    git init my-new-repo
-    cd my-new-repo
-    git pull git@github.com:nexB/skeleton
+- License: Apache-2.0 AND MIT
+- Copyright (c) nexB Inc., AboutCode, OWASP Foundation and others.
+- Homepage: https://github.com/aboutcode-org/binary-inspector
 
-    # Create the new repo on GitHub, then update your remote
-    git remote set-url origin [email protected]:nexB/your-new-repo.git
+Development
+----------------
 
-From here, you can make the appropriate changes to the files for your specific project.
+- Install requirements and dependencies using ``./configure --clean && ./configure --dev``
+- Then ``source venv/bin/activate``
 
-Update an existing project
----------------------------
-.. code-block:: bash
+Testing:
 
-    cd my-existing-project
-    git remote add skeleton [email protected]:nexB/skeleton
-    git fetch skeleton
-    git merge skeleton/main --allow-unrelated-histories
+- To run tests: ``pytest -vvs``
+- To regen test fixtures: ``SCANCODE_REGEN_TEST_FIXTURES=yes pytest -vvs``
 
-This is also the workflow to use when updating the skeleton files in any given repository.
+Acknowledgements, Funding, Support and Sponsoring
+--------------------------------------------------------
 
-More usage instructions can be found in ``docs/skeleton-usage.rst``.
+This project is funded, supported and sponsored by:
 
+- Generous support and contributions from users like you!
+- the European Commission NGI programme
+- the NLnet Foundation
+- the Swiss State Secretariat for Education, Research and Innovation (SERI)
+- Google, including the Google Summer of Code and the Google Seasons of Doc programmes
+- Mercedes-Benz Group
+- Microsoft and Microsoft Azure
+- AboutCode ASBL
+- nexB Inc.
 
-Release Notes
-=============
+This project also uses some functions from other packages:
 
-- 2023-07-18:
-    - Add macOS-13 job in azure-pipelines.yml
+- blint (https://github.com/owasp-dep-scan/blint)
+- symbolic (https://pypi.org/project/symbolic/)
+- lief (https://pypi.org/project/lief/)
 
-- 2022-03-04:
-    - Synchronize configure and configure.bat scripts for sanity
-    - Update CI operating system support with latest Azure OS images
-    - Streamline utility scripts in etc/scripts/ to create, fetch and manage third-party dependencies
-      There are now fewer scripts. See etc/scripts/README.rst for details
 
-- 2021-09-03:
-    - ``configure`` now requires pinned dependencies via the use of ``requirements.txt`` and ``requirements-dev.txt``
-    - ``configure`` can now accept multiple options at once
-    - Add utility scripts from scancode-toolkit/etc/release/ for use in generating project files
-    - Rename virtual environment directory from ``tmp`` to ``venv``
-    - Update README.rst with instructions for generating ``requirements.txt`` and ``requirements-dev.txt``,
-      as well as collecting dependencies as wheels and generating ABOUT files for them.
+|europa|   |dgconnect|
 
-- 2021-05-11:
-    - Adopt new configure scripts from ScanCode TK that allows correct configuration of which Python version is used.
+|ngi|   |nlnet|
+
+|aboutcode|  |nexb|
+
+
+
+This project was funded through the NGI0 Entrust Fund, a fund established by NLnet with financial
+support from the European Commission's Next Generation Internet programme, under the aegis of DG
+Communications Networks, Content and Technology under grant agreement No 101069594.
+
+|ngizeroentrust| https://nlnet.nl/project/Back2source/
+
+
+This project was funded through the NGI0 Core Fund, a fund established by NLnet with financial
+support from the European Commission's Next Generation Internet programme, under the aegis of DG
+Communications Networks, Content and Technology under grant agreement No 101092990.
+
+|ngizerocore| https://nlnet.nl/project/Back2source-next/
+
+
+This project was funded through the NGI0 Entrust Fund, a fund established by NLnet with financial
+support from the European Commission's Next Generation Internet programme, under the aegis of DG
+Communications Networks, Content and Technology under grant agreement No 101069594.
+
+|ngizeroentrust| https://nlnet.nl/project/purl2all/
+
+
+
+.. |nlnet| image:: https://nlnet.nl/logo/banner.png
+    :target: https://nlnet.nl
+    :height: 50
+    :alt: NLnet foundation logo
+
+.. |ngi| image:: https://ngi.eu/wp-content/uploads/thegem-logos/logo_8269bc6efcf731d34b6385775d76511d_1x.png
+    :target: https://ngi.eu35
+    :height: 50
+    :alt: NGI logo
+
+.. |nexb| image:: https://nexb.com/wp-content/uploads/2022/04/nexB.svg
+    :target: https://nexb.com
+    :height: 30
+    :alt: nexB logo
+
+.. |europa| image:: https://ngi.eu/wp-content/uploads/sites/77/2017/10/bandiera_stelle.png
+    :target: http://ec.europa.eu/index_en.htm
+    :height: 40
+    :alt: Europa logo
+
+.. |aboutcode| image:: https://aboutcode.org/wp-content/uploads/2023/10/AboutCode.svg
+    :target: https://aboutcode.org/
+    :height: 30
+    :alt: AboutCode logo
+
+.. |swiss| image:: https://www.sbfi.admin.ch/sbfi/en/_jcr_content/logo/image.imagespooler.png/1493119032540/logo.png
+    :target: https://www.sbfi.admin.ch/sbfi/en/home/seri/seri.html
+    :height: 40
+    :alt: Swiss logo
+
+.. |dgconnect| image:: https://commission.europa.eu/themes/contrib/oe_theme/dist/ec/images/logo/positive/logo-ec--en.svg
+    :target: https://commission.europa.eu/about-european-commission/departments-and-executive-agencies/communications-networks-content-and-technology_en
+    :height: 40
+    :alt: EC DG Connect logo
+
+.. |ngizerocore| image:: https://nlnet.nl/image/logos/NGI0_tag.svg
+    :target: https://nlnet.nl/core
+    :height: 40
+    :alt: NGI Zero Core Logo
+
+.. |ngizerocommons| image:: https://nlnet.nl/image/logos/NGI0_tag.svg
+    :target: https://nlnet.nl/commonsfund/
+    :height: 40
+    :alt: NGI Zero Commons Logo
+
+.. |ngizeropet| image:: https://nlnet.nl/image/logos/NGI0PET_tag.svg
+    :target: https://nlnet.nl/PET
+    :height: 40
+    :alt: NGI Zero PET logo
+
+.. |ngizeroentrust| image:: https://nlnet.nl/image/logos/NGI0Entrust_tag.svg
+    :target: https://nlnet.nl/entrust
+    :height: 38
+    :alt: NGI Zero Entrust logo
+
+.. |ngiassure| image:: https://nlnet.nl/image/logos/NGIAssure_tag.svg
+    :target: https://nlnet.nl/image/logos/NGIAssure_tag.svg
+    :height: 32
+    :alt: NGI Assure logo
+
+.. |ngidiscovery| image:: https://nlnet.nl/image/logos/NGI0Discovery_tag.svg
+    :target: https://nlnet.nl/discovery/
+    :height: 40
+    :alt: NGI Discovery logo

azure-pipelines.yml

@@ -7,58 +7,10 @@
 
 jobs:
 
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: ubuntu22_cpython
-          image_name: ubuntu-22.04
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
-
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: ubuntu24_cpython
           image_name: ubuntu-24.04
           python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: macos13_cpython
-          image_name: macOS-13
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: macos14_cpython_arm64
-          image_name: macOS-14
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: macos14_cpython
-          image_name: macOS-14-large
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
-
-    - template: etc/ci/azure-win.yml
-      parameters:
-          job_name: win2019_cpython
-          image_name: windows-2019
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
-          test_suites:
-              all: venv\Scripts\pytest -n 2 -vvs
-
-    - template: etc/ci/azure-win.yml
-      parameters:
-          job_name: win2022_cpython
-          image_name: windows-2022
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
-          test_suites:
-              all: venv\Scripts\pytest -n 2 -vvs

docs/source/index.rst

@@ -1,11 +1,10 @@
-Welcome to nexb-skeleton's documentation!
-=========================================
+Welcome to binary-inspector's documentation!
+============================================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   skeleton-usage
    contribute/contrib_doc
 
 Indices and tables