Checkpoint

Signed-off-by: Matthew Ballance <matt.ballance@gmail.com>

Author: mballance

.github/workflows/ci.yml

@@ -19,7 +19,8 @@ jobs:
         ./packages/python/bin/python3 -m pip install wheel twine
         ./packages/python/bin/python3 -m pip install pip setuptools --upgrade
         export BUILD_NUM=$GITHUB_RUN_ID
-        ./packages/python/bin/python3 setup.py bdist_wheel --universal
+        cd python
+        ../packages/python/bin/python3 setup.py bdist_wheel --universal
     - name: Build Docs
       run: |
         make html
@@ -37,4 +38,5 @@ jobs:
       with:
         user: __token__
         password: ${{ secrets.PYPI_API_TOKEN }}
+        packages-dir: python/dist/
 

Makefile

@@ -4,3 +4,7 @@ ROOTDIR:=$(dir $(abspath $(lastword $(MAKEFILE_LIST))))
 html :
 	@$(ROOTDIR)/packages/python/bin/sphinx-build -M html \
 		$(ROOTDIR)/doc/source $(ROOTDIR)/doc/build
+
+.PHONY: test-python-build
+test-python-build:
+	cd $(ROOTDIR)/python && $(ROOTDIR)/packages/python/bin/python3 setup.py bdist_wheel --universal

python/README.md

@@ -0,0 +1,58 @@
+# PyUCIS Viewer
+
+A Qt5-based graphical viewer for coverage data stored in UCIS (Unified Coverage Interoperability Standard) databases.
+
+## Overview
+
+PyUCIS Viewer is a simple, lightweight desktop application for exploring and analyzing functional and code coverage data. It reads coverage information from `.ucisdb` SQLite databases and presents it in an intuitive tree-based interface.
+
+## Features
+
+- Browse coverage hierarchy (instances, covergroups, coverpoints, bins)
+- View coverage statistics and metrics
+- Explore coverage data organized by design hierarchy
+- Inspect individual coverage items and their hit counts
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install pyucis-viewer
+```
+
+### From Source
+
+```bash
+cd python
+pip install -e .
+```
+
+## Usage
+
+Launch the viewer from the command line:
+
+```bash
+pyucis-viewer
+```
+
+Then use the GUI to open a `.ucisdb` file and navigate the coverage data.
+
+## Requirements
+
+- Python 3.7+
+- PyQt5
+- pyucis >= 0.0.6
+
+## Related Projects
+
+- [pyucis](https://github.com/fvutils/pyucis) - Python library for UCIS database access
+- [VSCode PyUCIS Extension](../vscode-extension) - VSCode extension for coverage exploration (in development)
+
+## License
+
+Apache 2.0
+
+## Author
+
+Matthew Ballance (matt.ballance@gmail.com)

setup.py python/setup.pysetup.py renamed to python/setup.py

@@ -1,12 +1,16 @@
 
 import os
+from pathlib import Path
 from setuptools import setup, find_namespace_packages
 
 version="0.0.4"
 
 if "BUILD_NUM" in os.environ.keys():
   version = version + "." + os.environ["BUILD_NUM"]
 
+# Read long description from README
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
 
 setup(
   name = "pyucis-viewer",
@@ -16,9 +20,8 @@
   author = "Matthew Ballance",
   author_email = "matt.ballance@gmail.com",
   description = ("PyUCIS Viewer QT5-based viewer for UCIS data."),
-  long_description = """
-  Extremely simple graphical viewer for coverage data in a UCIS database
-  """,
+  long_description = long_description,
+  long_description_content_type = "text/markdown",
   license = "Apache 2.0",
   keywords = ["SystemVerilog", "Verilog", "RTL", "Coverage"],
   url = "https://github.com/fvutils/pyucis-viewer",