REF: split out happi audit for programmatic usage - Githubissues

pcdshub / happi

Heuristic Access to Positions of Photon Instruments

https://pcdshub.github.io/happi/master

Other

13 stars 29 forks source link

REF: split out happi audit for programmatic usage #322

Closed klauer closed 1 year ago

klauer commented 1 year ago

Description

Allow for running happi audits programmatically without interfacing with click
Add some more type hints
Intercept KeyboardInterrupt and still show some results in happi audit (when you're working from a laptop that has access to zero PVs)

Motivation and Context

Touching back on auto-generated documentation pages:

I want to include happi audit information in the Confluence pages for each device and there's no really easy way to do this currently

How Has This Been Tested?

Test suite and interactively

Where Has This Been Documented?

This PR

Pre-merge checklist

[x] Code works interactively
[x] Code contains descriptive docstrings, including context and API
[x] New/changed functions and methods are covered in the test suite where possible
[x] Test suite passes locally
[x] Test suite passes on GitHub Actions
[x] Ran docs/pre-release-notes.sh and created a pre-release documentation page
[x] Pre-release docs include context, functional descriptions, and contributors as appropriate