Merge develop into master

.git-blame-ignore-revs

@@ -0,0 +1,6 @@
+# Run this command to always ignore formatting commits in `git blame`
+# git config blame.ignoreRevsFile .git-blame-ignore-revs
+
+# Formatting commit
+10e7047631b5807a951676eab6ede37200011283
+8a8b4c89769dcd2ee4c890c14518759aa4e62394

.github/workflows/ci.yml

@@ -10,6 +10,7 @@
   pull_request:
     branches:
       - master
+      - develop
 
 jobs:
   build_install:
@@ -33,68 +34,15 @@
         pip install -U pip
         pip install -U .
 
-  package-deploy:
-    name: Build the Python package, and deploy if needed
-    runs-on: ubuntu-latest
+  deploy:
+    name: Build and deploy ledgerblue package
     needs: build_install
-    steps:
-    - name: Clone
-      uses: actions/checkout@v3
-      with:
-        fetch-depth: 0
-
-    - name: Install dependencies
-      run: |
-        # Needed to workaround this bug https://github.com/pypa/setuptools/issues/4759
-        # To be removed when it's fixed
-        pip install -U packaging
-
-        python -m pip install pip --upgrade
-        pip install build twine
-
-    - name: Build the Python package
-      run: |
-        python -m build
-        twine check dist/*
-        echo "TAG_VERSION=$(python -c 'from ledgerblue import __version__; print(__version__)')" >> "$GITHUB_ENV"
-
-    - name: Display current status
-      run: |
-        echo "Current status is:"
-        if [[ ${{ github.ref }} == "refs/tags/"* ]];
-        then
-            echo "- Triggered from tag, will be deployed on pypi.org";
-        else
-            echo "- Not triggered from tag, will be deployed on test.pypi.org";
-        fi
-        echo "- Tag version: ${{ env.TAG_VERSION }}";
-
-    - name: Publish Python package on test.pypi.org
-      if: success() && github.event_name == 'push'
-      run: python -m twine upload --repository testpypi dist/*
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.TEST_PYPI_PUBLIC_API_TOKEN  }}
-        TWINE_NON_INTERACTIVE: 1
-
-    - name: Publish Python package on pypi.org
-      if: success() && github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
-      run: python -m twine upload dist/*
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_PUBLIC_API_TOKEN  }}
-        TWINE_NON_INTERACTIVE: 1
-
-    - name: Publish a release on the repo
-      if: |
-        success() &&
-        github.event_name == 'push' &&
-        startsWith(github.ref, 'refs/tags/')
-      uses: "marvinpinto/action-automatic-releases@latest"
-      with:
-        automatic_release_tag: "v${{ env.TAG_VERSION }}"
-        repo_token: "${{ secrets.GITHUB_TOKEN }}"
-        prerelease: false
-        files: |
-          LICENSE
-          dist/
+    uses: LedgerHQ/ledger-app-workflows/.github/workflows/reusable_pypi_deployment.yml@v1
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    with:
+      package_name: ledgerblue
+      jfrog_deployment: true
+      release: true
+      publish: true
+    secrets:
+      pypi_token: ${{ secrets.PYPI_PUBLIC_API_TOKEN }}

.github/workflows/documentation.yml

@@ -9,6 +9,7 @@ on:
   pull_request:
     branches:
       - master
+      - develop
 
 jobs:
   generate:
@@ -26,7 +27,7 @@ jobs:
       - name: Generate the documentation
         run: (cd doc && make html)
       - name: Upload documentation bundle
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: documentation
           path: doc/build/html/

.gitignore

@@ -2,5 +2,6 @@ build/
 dist/
 ledgerblue.egg-info/
 __pycache__
+.python-version
 
 __version__.py

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.3.7
+  hooks:
+    # Run the linter.
+    - id: ruff
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
+- repo: https://github.com/rhysd/actionlint
+  rev: v1.6.27
+  hooks:
+    - id: actionlint
+      files: ^\.github/workflows/.*\.ya?ml$

README.md

@@ -67,6 +67,19 @@ Use the following Target IDs (--targetId option) when running commands directly:
 | `Ledger Blue v2` | 2.1.x                              | `0x31010004` |
 
 
+## PCSC support
+
+This package can optionally work with PCSC readers for NFC communication with Ledger devices
+
+Installation instructions on linux:
+```
+apt install libpcsclite-dev
+pip3 install pyscard
+```
+
+Usage:
+If the environment variable `PCSC=1` is defined, ledgerblue tools will communicate through the first PCSC interface with a detected NFC tag
+
 ## Ledgerblue documentation
 
 You can generate the Ledgerblue documentation locally.

doc/source/conf.py

@@ -7,35 +7,37 @@
 
 from ledgerblue.__version__ import __version__
 
+
 def setup(app):
-    app.add_css_file('theme_overrides.css') # Override wide tables in RTD theme
+    app.add_css_file("theme_overrides.css")  # Override wide tables in RTD theme
+
 
 # General Configuration
 # =====================
 
 extensions = []
 
-source_suffix = ['.rst']
+source_suffix = [".rst"]
 
-master_doc = 'index'
+master_doc = "index"
 
-project = u'BOLOS Python Loader'
-copyright = u'2017, Ledger Team'
-author = u'Ledger Team'
+project = "BOLOS Python Loader"
+copyright = "2017, Ledger Team"
+author = "Ledger Team"
 
 version = __version__
 release = __version__
 
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # Options for HTML Output
 # =======================
 
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # sphinxarg
 # =========
 
-extensions += ['sphinxarg.ext']
+extensions += ["sphinxarg.ext"]

doc/source/script_reference.rst

@@ -11,6 +11,16 @@ checkGenuine.py
    :func: get_argparser
    :prog: python -m ledgerblue.checkGenuine
 
+.. _debugApp.py:
+
+debugApp.py
+-----------
+
+.. argparse::
+   :module: ledgerblue.debugApp
+   :func: get_argparser
+   :prog: python -m ledgerblue.debugApp
+
 .. _deleteApp.py:
 
 deleteApp.py