feat: give analyze the ability to display browsable results

[Poiuy7312]

closes #30

This gives analyze the sub commands --markdown-storage/-r and --display for storing the results in a markdown file and displaying it as a browsable frogmouth display when using --display

Ex

chasten analyze chasten --config $PWD/.chasten/ --debug-level ERROR --debug-dest CONSOLE --search-path . -r . --display

💫 chasten: Analyze the AST of Python Source Code
🔗 GitHub: https://github.com/gkapfham/chasten

✨ Configuration directory: C:\Users\Preston\CMPSC-203\ChastenProject\chasten\.chasten

✨ Validated C:\Users\Preston\CMPSC-203\ChastenProject\chasten\.chasten/config.yml? Yes
✨ Validated C:\Users\Preston\CMPSC-203\ChastenProject\chasten\.chasten/checks.yml? Yes

🐸 Frogmouth Information

 • Venv: C:\Users\Preston\AppData\Local\pypoetry\Cache\virtualenvs\chasten-Ti8Qy4ta-py3.11
 • Program: C:\Users\Preston\AppData\Local\pypoetry\Cache\virtualenvs\chasten-Ti8Qy4ta-py3.11/Scripts/frogmouth.exe

Display example:

[Poiuy7312]

I'm not sure if this is what was wanted but this is my attempt of giving something that stores the results in a readable form

[tuduun]

Hey @Poiuy7312 , can you please be more descriptive on what changes you have made on this PR? It would be helpful for your team if you could provide a description of what you have made that closes the issue #30 .

[gkapfham]

Hi @Poiuy7312 can you give an example of what the command-line looks like?
Can you also please give a screenshot that shows what output this produces?

[gkapfham]

Thanks @Poiuy7312 this is an awesome feature!

[gkapfham]

Hello @Poiuy7312 can you confirm that this is only for the analyze sub-command?

[gkapfham]

Also @tuduun, @laurennevill, and/or @jnormile can you review this and provide feedback?

[Poiuy7312]

Yes this is only for analyze

…

On Wed, Nov 1, 2023, 16:44 Gregory M. Kapfhammer ***@***.***> wrote: Hello @Poiuy7312 <https://github.com/Poiuy7312> can you confirm that this is only for the analyze sub-command? — Reply to this email directly, view it on GitHub <#94 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A2ZWPMBLUFSQ5VSBTYWWGWDYCKYDTAVCNFSM6AAAAAA6OEC3OGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTOOBZGY2TEMRVGY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[laurennevill]

I think this looks good. Thank you for including a descriptive PR with screenshots and examples. Great work!

[boulais01]

One really nitpicky thing - I would say that in main.py, on line 390, I would order the error codes to ignore numerically, so it goes # noq: PLR0912, PLR0913, PLR0915.

[boulais01]

Something I just noticed as well - make sure you update to master as well

[simojo]

Just as a note, merging master into your branch still hasn't fixed the downgrading of poetry.lock.

[boulais01]

@Poiuy7312 I was going to try and resolve the conflicts between the master main.py and the main.py here, but I'm not sure what some of the resolutions should be to maintain functionality. It's only three conflicts, so it shouldn't take long to resolve when you get the chance.