Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Generate Markdown reports for state and state comparisons #21

Open
KennethGrace opened this issue Dec 30, 2022 · 0 comments
Open

Generate Markdown reports for state and state comparisons #21

KennethGrace opened this issue Dec 30, 2022 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@KennethGrace
Copy link
Member

I want to use the Python openai package coupled with a user passed API key, to generate plain language reports from our data using the OpenAI api. We should be able to generate reports for both VOSS instances and Comparison instances.

This is probably best implemented through another ABC called Reportable. The Reportable class will require sub-classes to implement __str__ and __repr__. We will use the result of __str__ and __repr__ to format our classes into JSON documents. In addition to implementing these special functions, the class will also be required to implement a "report" method. For convenience, the Report class will implement a generate @classmethod for performing the OpenAI API call functionality.

@KennethGrace KennethGrace added the enhancement New feature or request label Dec 30, 2022
@KennethGrace KennethGrace self-assigned this Dec 30, 2022
@KennethGrace KennethGrace changed the title Generate Markdown reports Generate Markdown reports for state and state comparisons Dec 30, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant