feat/add include_slide_notes parameter

[mackurzawa]

Description

• Added include_slide_notes parameter, default is True. Works for .ppt and .pptx file extensions.
• Added two new files in sample-docs: sample-docs/notes.ppt, sample-docs/notes.pptx that include notes on their slides. This is to easily test the functionality, as there are no existing PowerPoint files that include slide notes.

Testing

#  using default value (True) returns additional NarrativeText element that contains notes
curl -X 'POST'   'http://localhost:8000/general/v0/general'   -H 'accept: application/json'   -H 'Content-Type: multipart/form-data'   -F 'files=@sample-docs/notes.pptx'   -F 'output_format="text/csv"' 

# explicit include_slide_notes=True returns additional NarrativeText element that contains notes
curl -X 'POST'   'http://localhost:8000/general/v0/general'   -H 'accept: application/json'   -H 'Content-Type: multipart/form-data'   -F 'files=@sample-docs/notes.pptx'   -F 'output_format="text/csv"' -F 'include_slide_notes=True'

# explicit include_slide_notes=False returns no NarrativeText element 
curl -X 'POST'   'http://localhost:8000/general/v0/general'   -H 'accept: application/json'   -H 'Content-Type: multipart/form-data'   -F 'files=@sample-docs/notes.pptx'   -F 'output_format="text/csv"' -F 'include_slide_notes=False'

Same with file notes.ppt

[plutasnyy]

This is heavy nit pick and don't feel obligated to update this test, but consider this a hint for the future ;)

There is a good practice in writing unit tests, or at least convention how unit tests can be named called given-when-then (much more popular in java where long function names are more natural).
check eg URL

So instead of putting logic in the test when something is expected I would create 2/3 tests like:
test_given_note_in_slide_when_variable_not_set_then_note_extracted

(avoid keywords, and you will be able create reasonable unit test name under 100 chars ;) )

this way you won't have to guess which part of the unit test was executed (avoid if/else), avoid putting strange logic parameteres inside test parametrization, won't do mistake in logic and the test will be much more self explaining ;)

[mackurzawa]

Wow, thank you so much for that detailed advice! Next time, I will consider splitting these kinds of tests rather than parameterizing one to contain so many cases. I will also work on improving the naming conventions. Great idea!

[mackurzawa]

Hey @awalker4,
Do you think it is worth mentioning this change in the changelog as a breaking change due to the different default behavior? Here’s why I’m wondering: if a user calls the API with a PowerPoint file that includes slide notes, they will receive additional elements related to those notes. While the previous elements will remain unchanged, their order might be different. I think it’s pretty rare for a user to care about the element order, but still, it might be worth noting

[awalker4]

LGTM! On the element order differences, I think it's worth adding another sentence in the changelog, but that's probably all I'd do in this case. Thanks!