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

feat: Jira-1883- Implementing Generate Report Functionality #37

Merged
merged 4 commits into from
Dec 20, 2024

Conversation

parth-kulkarni1
Copy link
Collaborator

@parth-kulkarni1 parth-kulkarni1 commented Nov 29, 2024

Jira-1883 - Implement Generate Report Functionality into Client Library - Minor

JIRA Ticket 1883

Checklist

  • If tests are required for this change, are they implemented?
  • Are user documentation changes required, if so, is there a task to track it and/or is it completed?
  • If developer/system documentation updates are required, is there a task to track it and/or is it completed?
  • At least one developer has reviewed this change (unless PR is being used to mark a commit point without need for review)?

Description

This PR contains the implementation of the Generate Report Functionality. An API call is made, and the bytes content is taken from the API response and written into a word file.

Notes for reviewer

  • This implementation required a newer addition of a generic validated_post_request method which makes a POST request and returns the raw response itself.

  • There were some small changes made in the write_file_helper method to also incorporate logic for writing bytes content.

  • No tests written as this is purely a Provena Web App functionality.

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 36.84211% with 24 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/provenaclient/clients/client_helpers.py 9.09% 10 Missing ⚠️
src/provenaclient/utils/helpers.py 11.11% 8 Missing ⚠️
src/provenaclient/clients/prov_client.py 42.85% 4 Missing ⚠️
src/provenaclient/modules/prov.py 50.00% 2 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Files with missing lines Coverage Δ
src/provenaclient/models/general.py 100.00% <100.00%> (ø)
src/provenaclient/modules/prov.py 52.17% <50.00%> (ø)
src/provenaclient/clients/prov_client.py 71.13% <42.85%> (ø)
src/provenaclient/utils/helpers.py 62.38% <11.11%> (ø)
src/provenaclient/clients/client_helpers.py 69.28% <9.09%> (ø)

@parth-kulkarni1 parth-kulkarni1 changed the title DRAFT: Jira-1883- Implementing Generate Report Functionality: DRAFT feat: Jira-1883- Implementing Generate Report Functionality Dec 5, 2024
@parth-kulkarni1 parth-kulkarni1 removed the draft draft label Dec 5, 2024
@jyucsiro
Copy link
Contributor

@parth-kulkarni1 has demo'd the functionality in a meeting with me. looks great! my suggestion was to add to the user docs so that people can see how to use this feature

@parth-kulkarni1
Copy link
Collaborator Author

@parth-kulkarni1 has demo'd the functionality in a meeting with me. looks great! my suggestion was to add to the user docs so that people can see how to use this feature

I added user docs now as well.

@jyucsiro jyucsiro self-requested a review December 20, 2024 05:24
Copy link
Contributor

@jyucsiro jyucsiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed code and tested it on local machine. Works and generates the report in docx format. Python notebook also contains example code for this feature.

@jyucsiro jyucsiro merged commit 9f6207c into main Dec 20, 2024
2 checks passed
@jyucsiro jyucsiro deleted the generate-report branch December 20, 2024 05:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants