binary-inspector 0.1.0__tar.gz → 0.1.2__tar.gz

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/.github/workflows/docs-ci.yml

@@ -21,14 +21,14 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Install Dependencies
-        run:  pip install -e .[docs]
+        run:  ./configure --dev
 
-      - name: Check Sphinx Documentation build minimally
-        working-directory: ./docs
-        run: sphinx-build -E -W source build
+      - name: Check documentation and HTML for errors and dead links
+        run: make docs-check
 
-      - name: Check for documentation style errors
-        working-directory: ./docs
-        run: ./scripts/doc8_style_check.sh
+      - name: Check documentation for style errors
+        run: make doc8
 
+      - name: Check code for style errors
+        run: make check
 

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/.github/workflows/pypi-release.yml

@@ -30,12 +30,15 @@ jobs:
         with:
           python-version: 3.12
 
-      - name: Install pypa/build
-        run: python -m pip install build --user
+      - name: Install pypa/build and twine
+        run: python -m pip install --user build twine
 
       - name: Build a binary wheel and a source tarball
         run: python -m build --sdist --wheel --outdir dist/
 
+      - name: Validate wheel and sdis for Pypi
+        run: python -m twine check dist/*
+
       - name: Upload built archives
         uses: actions/upload-artifact@v4
         with:

binary_inspector-0.1.2/.github/workflows/tests.yml

@@ -0,0 +1,27 @@
+name: Run tests on supported Python versions
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+    extensive_tests:
+        name: Run tests on Python ${{ matrix.python }}
+        runs-on: ${{ matrix.os }}
+        defaults:
+          run:
+            shell: bash
+        strategy:
+            fail-fast: false
+            matrix:
+                python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+                os: ["ubuntu-latest"]
+
+        steps:
+            - uses: actions/checkout@v4
+
+            - name: Set up Python
+              uses: actions/setup-python@v5
+              with:
+                python-version: "${{ matrix.python }}"
+
+            - name: Run tests
+              run: make clean && make dev && make test

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/.gitignore

@@ -72,3 +72,5 @@ tcl
 
 # Ignore Jupyter Notebook related temp files
 .ipynb_checkpoints/
+/.ruff_cache/
+.env

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/.readthedocs.yml

@@ -26,4 +26,4 @@ python:
     - method: pip
       path: .
       extra_requirements:
-        - docs
+        - dev

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/CHANGELOG.rst

@@ -1,6 +1,22 @@
 Changelog
 =========
 
+v0.1.2
+------
+
+Bugfix release to fix click compatibility issues:
+
+* Update commoncode to latest v32.3.0 with click compatibility fixes
+
+
+v0.1.1
+------
+
+Bugfix release as the intial release had empty wheels:
+
+* Fix binary-inspector wheels to have the necessary modules.
+* Update to latest skeleton
+
 
 v0.1.0
 ------

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/MANIFEST.in

@@ -1,4 +1,6 @@
 graft src
+graft docs
+graft etc
 
 include *.LICENSE
 include NOTICE
@@ -6,10 +8,18 @@ include *.ABOUT
 include *.toml
 include *.yml
 include *.rst
+include *.png
 include setup.*
 include configure*
 include requirements*
-include .git*
+include .dockerignore
+include .gitignore
+include .readthedocs.yml
+include manage.py
+include Dockerfile*
+include Makefile
+include MANIFEST.in
 
-global-exclude *.py[co] __pycache__ *.*~
+include .VERSION
 
+global-exclude *.py[co] __pycache__ *.*~

binary_inspector-0.1.2/Makefile

@@ -0,0 +1,60 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# 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/aboutcode-org/skeleton for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
+#
+
+# Python version can be specified with `$ PYTHON_EXE=python3.x make conf`
+PYTHON_EXE?=python3
+VENV=venv
+ACTIVATE?=. ${VENV}/bin/activate;
+
+
+conf:
+	@echo "-> Install dependencies"
+	./configure
+
+dev:
+	@echo "-> Configure and install development dependencies"
+	./configure --dev
+
+doc8:
+	@echo "-> Run doc8 validation"
+	@${ACTIVATE} doc8 --quiet docs/ *.rst
+
+valid:
+	@echo "-> Run Ruff format"
+	@${ACTIVATE} ruff format
+	@echo "-> Run Ruff linter"
+	@${ACTIVATE} ruff check --fix
+
+check:
+	@echo "-> Run Ruff linter validation (pycodestyle, bandit, isort, and more)"
+	@${ACTIVATE} ruff check
+	@echo "-> Run Ruff format validation"
+	@${ACTIVATE} ruff format --check
+	@$(MAKE) doc8
+	@echo "-> Run ABOUT files validation"
+	@${ACTIVATE} about check etc/
+
+clean:
+	@echo "-> Clean the Python env"
+	./configure --clean
+
+test:
+	@echo "-> Run the test suite"
+	${VENV}/bin/pytest -vvs
+
+docs:
+	rm -rf docs/_build/
+	@${ACTIVATE} sphinx-build docs/source docs/_build/
+
+docs-check:
+	@${ACTIVATE} sphinx-build -E -W -b html docs/source docs/_build/
+	@${ACTIVATE} sphinx-build -E -W -b linkcheck docs/source docs/_build/
+
+.PHONY: conf dev check valid clean test docs docs-check

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: binary-inspector
-Version: 0.1.0
+Version: 0.1.2
 Summary: binary-inspector is a library and tools to inspect binaries (elf, winpe, mach0) for symbols and other information, and models to store this.
 Home-page: https://github.com/aboutcode-org/binary-inspector
 Author: nexB. Inc. and others
@@ -20,29 +20,28 @@ License-File: NOTICE
 License-File: AUTHORS.rst
 License-File: CHANGELOG.rst
 License-File: CODE_OF_CONDUCT.rst
-Requires-Dist: click<8.2
+License-File: README.rst
+Requires-Dist: click!=7.0,>=6.7; python_version < "3.10"
+Requires-Dist: click>=8.2.0; python_version >= "3.10"
 Requires-Dist: commoncode
 Requires-Dist: plugincode
 Requires-Dist: typecode
 Requires-Dist: lief==0.15.1
 Requires-Dist: symbolic==10.2.1
-Provides-Extra: testing
-Requires-Dist: scancode-toolkit; extra == "testing"
-Requires-Dist: pytest!=7.0.0,>=6; extra == "testing"
-Requires-Dist: pytest-xdist>=2; extra == "testing"
-Requires-Dist: aboutcode-toolkit>=7.0.2; extra == "testing"
-Requires-Dist: pycodestyle>=2.8.0; extra == "testing"
-Requires-Dist: twine; extra == "testing"
-Requires-Dist: black; extra == "testing"
-Requires-Dist: isort; extra == "testing"
-Provides-Extra: docs
-Requires-Dist: Sphinx>=5.0.2; extra == "docs"
-Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "docs"
-Requires-Dist: sphinx-reredirects>=0.1.2; extra == "docs"
-Requires-Dist: doc8>=0.11.2; extra == "docs"
-Requires-Dist: sphinx-autobuild; extra == "docs"
-Requires-Dist: sphinx-rtd-dark-mode>=1.3.0; extra == "docs"
-Requires-Dist: sphinx-copybutton; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: scancode-toolkit; extra == "dev"
+Requires-Dist: pytest>=7.0.1; extra == "dev"
+Requires-Dist: pytest-xdist>=2; extra == "dev"
+Requires-Dist: aboutcode-toolkit>=7.0.2; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: Sphinx>=5.0.2; extra == "dev"
+Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "dev"
+Requires-Dist: sphinx-reredirects>=0.1.2; extra == "dev"
+Requires-Dist: doc8>=0.11.2; extra == "dev"
+Requires-Dist: sphinx-autobuild; extra == "dev"
+Requires-Dist: sphinx-rtd-dark-mode>=1.3.0; extra == "dev"
+Requires-Dist: sphinx-copybutton; extra == "dev"
 Dynamic: license-file
 
 binary-inspector
@@ -52,10 +51,9 @@ 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:
+To install run ``pip install binary-inspector`` and use with::
 
-- Run ``pip install binary-inspector``
-- Use with ``scancode --json-pp - --macho-symbol --winpe-symbol --verbose <PATH to a tree or file with binaries>``
+    scancode --json-pp - --macho-symbol --winpe-symbol --verbose <PATH to a tree or file with binaries>
 
 The JSON output will contain binary symbols found in binaries if any.
 
@@ -132,7 +130,7 @@ Communications Networks, Content and Technology under grant agreement No 1010695
     :alt: NLnet foundation logo
 
 .. |ngi| image:: https://ngi.eu/wp-content/uploads/thegem-logos/logo_8269bc6efcf731d34b6385775d76511d_1x.png
-    :target: https://ngi.eu35
+    :target: https://ngi.eu
     :height: 50
     :alt: NGI logo
 
@@ -142,7 +140,7 @@ Communications Networks, Content and Technology under grant agreement No 1010695
     :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
+    :target: https://commission.europa.eu/index_en
     :height: 40
     :alt: Europa logo
 

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/README.rst

@@ -5,10 +5,9 @@ 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:
+To install run ``pip install binary-inspector`` and use with::
 
-- Run ``pip install binary-inspector``
-- Use with ``scancode --json-pp - --macho-symbol --winpe-symbol --verbose <PATH to a tree or file with binaries>``
+    scancode --json-pp - --macho-symbol --winpe-symbol --verbose <PATH to a tree or file with binaries>
 
 The JSON output will contain binary symbols found in binaries if any.
 
@@ -85,7 +84,7 @@ Communications Networks, Content and Technology under grant agreement No 1010695
     :alt: NLnet foundation logo
 
 .. |ngi| image:: https://ngi.eu/wp-content/uploads/thegem-logos/logo_8269bc6efcf731d34b6385775d76511d_1x.png
-    :target: https://ngi.eu35
+    :target: https://ngi.eu
     :height: 50
     :alt: NGI logo
 
@@ -95,7 +94,7 @@ Communications Networks, Content and Technology under grant agreement No 1010695
     :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
+    :target: https://commission.europa.eu/index_en
     :height: 40
     :alt: Europa logo
 

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/configure

@@ -29,14 +29,13 @@ CLI_ARGS=$1
 
 # Requirement arguments passed to pip and used by default or with --dev.
 REQUIREMENTS="--editable . --constraint requirements.txt"
-DEV_REQUIREMENTS="--editable .[testing] --constraint requirements.txt --constraint requirements-dev.txt"
-DOCS_REQUIREMENTS="--editable .[docs] --constraint requirements.txt"
+DEV_REQUIREMENTS="--editable .[dev] --constraint requirements.txt --constraint requirements-dev.txt"
 
 # where we create a virtualenv
 VIRTUALENV_DIR=venv
 
 # Cleanable files and directories to delete with the --clean option
-CLEANABLE="build dist venv .cache .eggs"
+CLEANABLE="build dist venv .cache .eggs *.egg-info docs/_build/ pip-selfcheck.json"
 
 # extra  arguments passed to pip
 PIP_EXTRA_ARGS=" "
@@ -168,6 +167,7 @@ clean() {
     for cln in $CLEANABLE;
         do rm -rf "${CFG_ROOT_DIR:?}/${cln:?}";
     done
+    find . -type f -name '*.py[co]' -delete -o -type d -name __pycache__ -delete
     set +e
     exit
 }
@@ -185,7 +185,6 @@ while getopts :-: optchar; do
                 help  ) cli_help;;
                 clean ) find_python && clean;;
                 dev   ) CFG_REQUIREMENTS="$DEV_REQUIREMENTS";;
-                docs   ) CFG_REQUIREMENTS="$DOCS_REQUIREMENTS";;
             esac;;
     esac
 done

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/configure.bat

@@ -27,8 +27,7 @@
 
 @rem # Requirement arguments passed to pip and used by default or with --dev.
 set "REQUIREMENTS=--editable . --constraint requirements.txt"
-set "DEV_REQUIREMENTS=--editable .[testing] --constraint requirements.txt --constraint requirements-dev.txt"
-set "DOCS_REQUIREMENTS=--editable .[docs] --constraint requirements.txt"
+set "DEV_REQUIREMENTS=--editable .[dev] --constraint requirements.txt --constraint requirements-dev.txt"
 
 @rem # where we create a virtualenv
 set "VIRTUALENV_DIR=venv"
@@ -76,9 +75,6 @@ if not "%1" == "" (
     if "%1" EQU "--dev"    (
         set "CFG_REQUIREMENTS=%DEV_REQUIREMENTS%"
     )
-    if "%1" EQU "--docs"    (
-        set "CFG_REQUIREMENTS=%DOCS_REQUIREMENTS%"
-    )
     shift
     goto again
 )

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/docs/Makefile

@@ -7,7 +7,7 @@ SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SPHINXAUTOBUILD = sphinx-autobuild
 SOURCEDIR     = source
-BUILDDIR      = build
+BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/docs/source/conf.py

@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "nexb-skeleton"
-copyright = "nexB Inc. and others."
+copyright = "nexB Inc., AboutCode and others."
 author = "AboutCode.org authors and contributors"
 
 
@@ -94,7 +94,8 @@ html_css_files = [
 html_show_sphinx = True
 
 # Define CSS and HTML abbreviations used in .rst files.  These are examples.
-# .. role:: is used to refer to styles defined in _static/theme_overrides.css and is used like this: :red:`text`
+# .. role:: is used to refer to styles defined in _static/theme_overrides.css
+# and is used like this: :red:`text`
 rst_prolog = """
 .. |psf| replace:: Python Software Foundation
 

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/docs/source/contribute/contrib_doc.rst

@@ -8,109 +8,59 @@ Contributing to the Documentation
 Setup Local Build
 -----------------
 
-To get started, create or identify a working directory on your local machine.
+To get started, check out and configure the repository for development::
 
-Open that directory and execute the following command in a terminal session::
+    git clone https://github.com/aboutcode-org/<your-repo>.git
 
-    git clone https://github.com/aboutcode-org/skeleton.git
+    cd your-repo
+    ./configure --dev
 
-That will create an ``/skeleton`` directory in your working directory.
-Now you can install the dependencies in a virtualenv::
-
-    cd skeleton
-    ./configure --docs
+(Or use "make dev")
 
 .. note::
 
-    In case of windows, run ``configure --docs`` instead of this.
-
-Now, this will install the following prerequisites:
-
-- Sphinx
-- sphinx_rtd_theme (the format theme used by ReadTheDocs)
-- docs8 (style linter)
+    In case of windows, run ``configure --dev``.
 
-These requirements are already present in setup.cfg and `./configure --docs` installs them.
+This will install and configure all requirements foer development including for docs development.
 
-Now you can build the HTML documents locally::
+Now you can build the HTML documentation locally::
 
     source venv/bin/activate
-    cd docs
-    make html
-
-Assuming that your Sphinx installation was successful, Sphinx should build a local instance of the
-documentation .html files::
-
-    open build/html/index.html
+    make docs
 
-.. note::
-
-    In case this command did not work, for example on Ubuntu 18.04 you may get a message like “Couldn’t
-    get a file descriptor referring to the console”, try:
+This will build a local instance of the ``docs/_build`` directory::
 
-    ::
+    open docs/_build/index.html
 
-        see build/html/index.html
 
-You now have a local build of the AboutCode documents.
+To validate the documentation style and content, use::
 
-.. _contrib_doc_share_improvements:
-
-Share Document Improvements
----------------------------
-
-Ensure that you have the latest files::
-
-    git pull
-    git status
-
-Before commiting changes run Continious Integration Scripts locally to run tests. Refer
-:ref:`doc_ci` for instructions on the same.
-
-Follow standard git procedures to upload your new and modified files. The following commands are
-examples::
-
-    git status
-    git add source/index.rst
-    git add source/how-to-scan.rst
-    git status
-    git commit -m "New how-to document that explains how to scan"
-    git status
-    git push
-    git status
-
-The Scancode-Toolkit webhook with ReadTheDocs should rebuild the documentation after your
-Pull Request is Merged.
+    source venv/bin/activate
+    make doc8
+    make docs-check
 
-Refer the `Pro Git Book <https://git-scm.com/book/en/v2/>`_ available online for Git tutorials
-covering more complex topics on Branching, Merging, Rebasing etc.
 
 .. _doc_ci:
 
 Continuous Integration
 ----------------------
 
-The documentations are checked on every new commit through Travis-CI, so that common errors are
-avoided and documentation standards are enforced. Travis-CI presently checks for these 3 aspects
-of the documentation :
+The documentations are checked on every new commit, so that common errors are avoided and
+documentation standards are enforced. We checks for these aspects of the documentation:
 
 1. Successful Builds (By using ``sphinx-build``)
-2. No Broken Links   (By Using ``link-check``)
-3. Linting Errors    (By Using ``Doc8``)
+2. No Broken Links   (By Using ``linkcheck``)
+3. Linting Errors    (By Using ``doc8``)
 
-So run these scripts at your local system before creating a Pull Request::
+You myst run these scripts locally before creating a pull request::
 
-    cd docs
-    ./scripts/sphinx_build_link_check.sh
-    ./scripts/doc8_style_check.sh
+    make doc8
+    make check-docs
 
-If you don't have permission to run the scripts, run::
-
-    chmod u+x ./scripts/doc8_style_check.sh
 
 .. _doc_style_docs8:
 
-Style Checks Using ``Doc8``
+Style Checks Using ``doc8``
 ---------------------------
 
 How To Run Style Tests
@@ -118,8 +68,7 @@ How To Run Style Tests
 
 In the project root, run the following commands::
 
-    $ cd docs
-    $ ./scripts/doc8_style_check.sh
+    make doc8
 
 A sample output is::
 
@@ -147,7 +96,8 @@ What is Checked?
 ^^^^^^^^^^^^^^^^
 
 PyCQA is an Organization for code quality tools (and plugins) for the Python programming language.
-Doc8 is a sub-project of the same Organization. Refer this `README <https://github.com/PyCQA/doc8/blob/master/README.rst>`_ for more details.
+Doc8 is a sub-project of the same Organization. Refer this
+`README <https://github.com/PyCQA/doc8/blob/main/README.rst>`_ for more details.
 
 What is checked:
 
@@ -169,11 +119,13 @@ What is checked:
 Interspinx
 ----------
 
-ScanCode toolkit documentation uses `Intersphinx <http://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>`_
+AboutCode documentation uses
+`Intersphinx <https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>`_
 to link to other Sphinx Documentations, to maintain links to other Aboutcode Projects.
 
 To link sections in the same documentation, standart reST labels are used. Refer
-`Cross-Referencing <http://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#ref-role>`_ for more information.
+`Cross-Referencing <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html>`_
+for more information.
 
 For example::
 
@@ -230,7 +182,7 @@ Style Conventions for the Documentaion
 
 1. Headings
 
-    (`Refer <http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections>`_)
+    (`Refer <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections>`_)
     Normally, there are no heading levels assigned to certain characters as the structure is
     determined from the succession of headings. However, this convention is used in Python’s Style
     Guide for documenting which you may follow:
@@ -303,12 +255,14 @@ Style Conventions for the Documentaion
     ``rst_snippets/warning_snippets/`` and then included to eliminate redundancy, as these are
     frequently used in multiple files.
 
+
 Converting from Markdown
 ------------------------
 
-If you want to convert a ``.md`` file to a ``.rst`` file, this `tool <https://github.com/chrissimpkins/md2rst>`_
-does it pretty well. You'd still have to clean up and check for errors as this contains a lot of
-bugs. But this is definitely better than converting everything by yourself.
+If you want to convert a ``.md`` file to a ``.rst`` file, this
+`tool <https://github.com/chrissimpkins/md2rst>`_ does it pretty well.
+You will still have to clean up and check for errors as this contains a lot of bugs. But this is
+definitely better than converting everything by yourself.
 
 This will be helpful in converting GitHub wiki's (Markdown Files) to reStructuredtext files for
 Sphinx/ReadTheDocs hosting.

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/docs/source/index.rst

@@ -1,6 +1,8 @@
 Welcome to binary-inspector's documentation!
 ============================================
 
+.. include:: ../../README.rst
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:

{binary_inspector-0.1.0 → binary_inspector-0.1.2}/etc/scripts/check_thirdparty.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 #
 # Copyright (c) nexB Inc. and others. All rights reserved.
 # ScanCode is a trademark of nexB Inc.
@@ -17,8 +16,7 @@ import utils_thirdparty
 @click.option(
     "-d",
     "--dest",
-    type=click.Path(exists=True, readable=True,
-                    path_type=str, file_okay=False),
+    type=click.Path(exists=True, readable=True, path_type=str, file_okay=False),
     required=True,
     help="Path to the thirdparty directory to check.",
 )
@@ -43,8 +41,7 @@ def check_thirdparty_dir(
     """
     Check a thirdparty directory for problems and print these on screen.
     """
-    # check for problems
-    print(f"==> CHECK FOR PROBLEMS")
+    print("==> CHECK FOR PROBLEMS")
     utils_thirdparty.find_problems(
         dest_dir=dest,
         report_missing_sources=sdists,