Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[FEATURE] Dump results into a JSON #81

Open
jeertmans opened this issue Sep 28, 2024 · 0 comments
Open

[FEATURE] Dump results into a JSON #81

jeertmans opened this issue Sep 28, 2024 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest Issue that is created for the Hacktoberfest event

Comments

@jeertmans
Copy link
Owner

Issue

Currently, results are printed out to the terminal, in a relatively nice looking table.

However, this means information could be very hard to extract if one, e.g., wanted to use rpdf and pipe it's output to another tool.

I think a more structured output format could be very useful.

Suggested fix

I suggest we offer JSON output format, that will output the information to a terminal (or file?) in a structured way.

To do so, each command should return a structure, that contains relevant statistics about the PDFs processed. Then, the structure will either derive JSON and be printed as a raw JSON, or transformed into a nice table (as this is already the case). Some option like pretty formatting and write to file could be also added to that JSON output.

If you are interested to help, please feel free to submit a PR or ask any question :-)

@jeertmans jeertmans added enhancement New feature or request good first issue Good for newcomers hacktoberfest Issue that is created for the Hacktoberfest event labels Sep 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest Issue that is created for the Hacktoberfest event
Projects
None yet
Development

No branches or pull requests

1 participant