AstuteSource / chasten

:dizzy: Chasten Uses XML and XPATH to Check a Python Program's AST for Specified Patterns!
https://pypi.org/project/chasten/
GNU General Public License v2.0
7 stars 8 forks source link

Create a Markdown Report (Or Some Other "Browse-able" Report) for an Analysis #30

Closed gkapfham closed 10 months ago

gkapfham commented 1 year ago

While chasten analyze provides a significant amount of output, especially when it is run in verbose mode, it does not have a way to save an analysis report in any format except for JSON. It would be nice if the tool could also produce a "browse-able" report in Markdown format or, alternatively, offer a terminal user-interface (TUI) mode that supports the browsing of results. Ultimately, the tool needs some human-friendly way to browse the results! With that said, it is important to note that there is one way to browse results right now --- and that is through the Datasette interface that you can run after using the chasten integrate and chasten datasette-serve or chasten datasette-publish commands. However, these seem somewhat "heavyweight" and I anticipate that it will still be great if there was a way to browse one or more result files in a terminal window either by using rich-cli on a Markdown file or through a bespoke TUI.