Merge pull request #880 from zapta/main

Assorted tweaks

Author: zapta

.github/workflows/monitor-apio-pypi.yaml

@@ -72,8 +72,8 @@ jobs:
                 apio sim --no-gtkwave
                 apio graph -n
                 apio format
-                apio devices usb
-                apio devices serial
+                apio devices scan-usb
+                apio devices scan-serial
 
                 find .
 

.github/workflows/publish-to-pypi.yaml

@@ -5,7 +5,7 @@ on:
   workflow_dispatch:
     inputs:
       release_tag:
-        description: "Release tag, e.g. 2025-12-10"
+        description: "Apio CLI release tag, e.g. 2025-12-10"
         required: true
         type: string
 
@@ -79,6 +79,10 @@ jobs:
           # Creates dist/*.tar.gz and dist/*.whl from pyproject.toml
           python -m build
 
+      - name: List package items
+        run: |
+          tar -tzf dist/*.tar.gz | tree --fromfile .
+
       # -- Publish to Pypi!!
       - name: Publish to PyPi
         env:

README.md

@@ -3,14 +3,14 @@ This README page is optimized for its appearance in the github repo rather than
 -->
 
 <!-- Page banner -->
-![apio-cli-banner](media/apio-cli-banner.png)
+![apio-cli-banner](https://raw.githubusercontent.com/zapta/apio/main/media/apio-cli-banner.png)
 
 <!-- Attributes badges -->
 [![license](https://img.shields.io/badge/License-GPL%203.0-blue.svg)](https://github.com/FPGAwars/apio/blob/main/LICENSE)
 [![python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)](https://pypi.org/project/apio)
 
 <!-- Platforms badges -->
-![linux](media/linux-logo.png)&nbsp;&nbsp;&nbsp;![macos](media/macosx-logo.png)&nbsp;&nbsp;&nbsp;![windows](media/windows-logo.png)&nbsp;&nbsp;&nbsp;![raspberry-pi](media/raspbian-logo.png)
+![linux](https://raw.githubusercontent.com/zapta/apio/main/media/linux-logo.png)&nbsp;&nbsp;&nbsp;![macos](https://raw.githubusercontent.com/zapta/apio/main/media/macosx-logo.png)&nbsp;&nbsp;&nbsp;![windows](https://raw.githubusercontent.com/zapta/apio/main/media/windows-logo.png)&nbsp;&nbsp;&nbsp;![raspberry-pi](media/raspbian-logo.png)
 
 <!-- Status badges -->
 [![cli-test](https://img.shields.io/github/actions/workflow/status/fpgawars/apio/test.yaml?label=cli-test)](https://github.com/fpgawars/apio/actions/workflows/test.yaml)
@@ -33,13 +33,18 @@ This README page is optimized for its appearance in the github repo rather than
 
 ---
 
+
+> **NOTE:&nbsp;&nbsp;Apio IDE for Visual Studio Code.**
+> Apio is also available as an extension for Visual Studio Code. To install it, visit the [Apio IDE page](https://marketplace.visualstudio.com/items?itemName=fpgawars.apio) in the Visual Studio Code Marketplace. 
+> The rest of this page describes the command line version of Apio.
+
+
 Apio CLI is an easy to install and use command-line tool for FPGA design from A to Z. For a quick start, visit the [Getting started with Apio](https://fpgawars.github.io/apio/docs/quick-start) guide.
 
-<br>
 
 Simulation example:
 
-![GTKWave screenshot](media/sim-gtkwave.png)
+![GTKWave screenshot](https://raw.githubusercontent.com/zapta/apio/main/media/sim-gtkwave.png)
 
 ## Description
 
@@ -57,7 +62,7 @@ Apio CLI currently supports over 80 FPGA boards, custom boards can be easily add
 4. `apio sim` - simulate the design and show signals.
 5. `apio upload` - program the FPGA board.
 
-![apio-cli-animation](media/apio-cli-animation.gif)
+![apio-cli-animation](https://raw.githubusercontent.com/zapta/apio/main/media/apio-cli-animation.gif)
 
 ## Apio CLI in the media
 

apio/__init__.py

@@ -14,7 +14,7 @@
 # -- DEVELOPER:
 # -- Change this release number and date when releasing a new Apio CLI version.
 # -- If incrementing Major or Minor, a new remote config file is required.
-APIO_VERSION = (1, 4, 0)  # Major, Minor, Patch.
+APIO_VERSION = (1, 4, 1)  # Major, Minor, Patch.
 
 # -- This is set automatically during build or publishing information to
 # -- provide additional information about the release. This string is included

pyproject.toml

@@ -9,8 +9,8 @@ build-backend = "flit_core.buildapi"
 "Homepage" = "https://github.com/fpgawars/apio"
 "Documentation" = "https://fpgawars.github.io/apio/docs"
 "Bugs Tracker" = "https://github.com/fpgawars/apio/issues"
-"Wiki" = "https://github.com/fpgawars/apio/wiki"
 "Discussions" = "https://github.com/fpgawars/apio/discussions"
+"Apio IDE" = "https://marketplace.visualstudio.com/items?itemName=fpgawars.apio"
 
 [tool.flit.metadata]
 module = "apio"
@@ -56,14 +56,15 @@ requires = [
 ]
 
 [tool.flit.sdist]
-# TODO: Revisit 'exclude`. What else we don't need in the package?
-exclude = ["tests/"]
-
-[tool.flit.metadata.requires-extra]
-blackiceprog = ['blackiceprog==2.0.0']
-litterbox = ['litterbox==0.2.2']
-tinyfpgab = ['tinyfpgab==1.1.0']
-icefunprog = ['icefunprog==2.0.3']
+# Note that we don't include 'media/' nor do we have relative references
+# from README.md to resources in media since pypi doesn't show them 
+# correctly. Instead we use absolute links to github.
+include = [
+    "apio/",
+    "pyproject.toml",
+    "README.md",
+    "LICENSE",
+]
 
 [tool.flit.scripts]
 apio = "apio.__main__:main"