Get binary symbols from ELF

.github/workflows/docs-ci.yml

@@ -4,25 +4,22 @@ on: [push, pull_request]
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.9]
+        python-version: [3.12]
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Give permission to run scripts
-        run: chmod +x ./docs/scripts/doc8_style_check.sh
-
       - name: Install Dependencies
         run:  pip install -e .[docs]
 

.github/workflows/pypi-release.yml

@@ -21,14 +21,14 @@ on:
 jobs:
   build-pypi-distribs:
     name: Build and publish library to PyPI
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: 3.12
 
       - name: Install pypa/build
         run: python -m pip install build --user
@@ -37,7 +37,7 @@ jobs:
         run: python -m build --sdist --wheel --outdir dist/
 
       - name: Upload built archives
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: pypi_archives
           path: dist/*
@@ -47,17 +47,17 @@ jobs:
     name: Create GH release
     needs:
       - build-pypi-distribs
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     steps:
       - name: Download built archives
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: pypi_archives
           path: dist
 
       - name: Create GH release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           draft: true
           files: dist/*
@@ -67,11 +67,11 @@ jobs:
     name: Create PyPI release
     needs:
       - create-gh-release
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     steps:
       - name: Download built archives
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: pypi_archives
           path: dist

CHANGELOG.rst

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+v0.0.3
+------
+
+- Collect binary symbols from ELF binaries using BIDS
+  https://pypi.org/project/bids-analyser/0.2.0/
+  Also make this available in the scancode-toolkit plugin ``--elf``.
+
 v0.0.2
 ------
 

Makefile

@@ -4,7 +4,7 @@
 # ScanCode is a trademark of nexB Inc.
 # SPDX-License-Identifier: Apache-2.0
 # See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
-# See https://github.com/nexB/skeleton for support or download.
+# See https://github.com/aboutcode-org/skeleton for support or download.
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
 
@@ -35,7 +35,7 @@ check:
 	@echo "-> Run pycodestyle (PEP8) validation"
 	@${ACTIVATE} pycodestyle --max-line-length=100 --exclude=.eggs,venv,lib,thirdparty,docs,migrations,settings.py,.cache .
 	@echo "-> Run isort imports ordering validation"
-	@${ACTIVATE} isort --sl --check-only -l 100 setup.py src tests . 
+	@${ACTIVATE} isort --sl --check-only -l 100 setup.py src tests .
 	@echo "-> Run black validation"
 	@${ACTIVATE} black --check --check -l 100 src tests setup.py
 

README.rst

@@ -5,6 +5,9 @@ elf-inspector is a set of utilities to inspect binary ELF files and collect
 interesting data from them. This is also a ScanCode-toolkit plugin
 and is also designed to work integrated in ScanCode.io for binary analysis.
 
+This library uses:
+- [pyelftools](https://github.com/eliben/pyelftools)
+- [bids-analyser](https://github.com/APH10/BIDS)
 
 To install and use:
 
@@ -13,8 +16,8 @@ To install and use:
 
     --dwarf           Collect source code path from compilation units found in
                       ELF DWARFs.
-    --elf             Collect dependent library names needed by an ELF binary
-                      file.
+    --elf             Collect symbols and required dependent library names from
+                      an ELF binary file.
 
 - Use with ``scancode --json-pp - --dwarf --elf --verbose <PATH to a tree or file with ELF binaries>``
 

azure-pipelines.yml

@@ -5,50 +5,34 @@
 ################################################################################
 
 jobs:
-  - template: etc/ci/azure-posix.yml
-    parameters:
-      job_name: ubuntu20_cpython
-      image_name: ubuntu-20.04
-      python_versions: ["3.7", "3.8", "3.9", "3.10", "3.11"]
-      test_suites:
-        all: venv/bin/pytest -n 2 -vvs
-
   - template: etc/ci/azure-posix.yml
     parameters:
       job_name: ubuntu22_cpython
       image_name: ubuntu-22.04
-      python_versions: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+      python_versions: ["3.9", "3.10", "3.11", "3.12"]
       test_suites:
-        all: venv/bin/pytest -n 2 -vvs
+        all: venv/bin/pytest -n 2 -vvs tests
 
   - template: etc/ci/azure-posix.yml
     parameters:
-      job_name: macos12_cpython
-      image_name: macOS-12
-      python_versions: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+      job_name: ubuntu24_cpython
+      image_name: ubuntu-24.04
+      python_versions: ["3.9", "3.10", "3.11", "3.12"]
       test_suites:
-        all: venv/bin/pytest -n 2 -vvs
+        all: venv/bin/pytest -n 2 -vvs tests
 
   - template: etc/ci/azure-posix.yml
     parameters:
       job_name: macos13_cpython
       image_name: macOS-13
-      python_versions: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+      python_versions: ["3.9", "3.10", "3.11", "3.12"]
       test_suites:
-        all: venv/bin/pytest -n 2 -vvs
+        all: venv/bin/pytest -n 2 -vvs tests
 
-  - template: etc/ci/azure-win.yml
-    parameters:
-      job_name: win2019_cpython
-      image_name: windows-2019
-      python_versions: ["3.7", "3.8", "3.9", "3.10", "3.11"]
-      test_suites:
-        all: venv\Scripts\pytest -n 2 -vvs
-
-  - template: etc/ci/azure-win.yml
+  - template: etc/ci/azure-posix.yml
     parameters:
-      job_name: win2022_cpython
-      image_name: windows-2022
-      python_versions: ["3.7", "3.8", "3.9", "3.10", "3.11"]
-      test_suites:
-        all: venv\Scripts\pytest -n 2 -vvs
+        job_name: macos14_cpython_arm64
+        image_name: macOS-14
+        python_versions: ["3.9", "3.10", "3.11", "3.12"]
+        test_suites:
+            all: venv/bin/pytest -n 2 -vvs tests

docs/Makefile

@@ -5,6 +5,7 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
+SPHINXAUTOBUILD = sphinx-autobuild
 SOURCEDIR     = source
 BUILDDIR      = build
 
@@ -14,6 +15,13 @@ help:
 
 .PHONY: help Makefile
 
+# Run the development server using sphinx-autobuild
+docs:
+	@echo
+	@echo "Starting up the docs server..."
+	@echo
+	$(SPHINXAUTOBUILD) --port 8000 --watch ${SOURCEDIR} $(SOURCEDIR) "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

docs/make.bat

@@ -7,11 +7,16 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
+if "%SPHINXAUTOBUILD%" == "" (
+	set SPHINXAUTOBUILD=sphinx-autobuild
+)
 set SOURCEDIR=source
 set BUILDDIR=build
 
 if "%1" == "" goto help
 
+if "%1" == "docs" goto docs
+
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.
@@ -28,6 +33,13 @@ if errorlevel 9009 (
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 
+:docs
+@echo
+@echo Starting up the docs server...
+@echo
+%SPHINXAUTOBUILD% --port 8000 --watch %SOURCEDIR% %SOURCEDIR% %BUILDDIR%\html %SPHINXOPTS% %O%
+goto end
+
 :help
 %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%