ENH: Add option to specify a folder to extract the images

[Nusab19]

Please explain your intent
In the extract-images command, it extracts the images in the current directory. It's be better if there was an option to set the output folder.

Describe the solution you'd like
A new argument --output following the folderName.

[Lucas-C]

Agreed, we could add an --output-dir option 🙂

Would you like to contribute a PR to add this?

[Nusab19]

Would you like to contribute a PR to add this?

I would. But I'm in the middle of exams and can't really get much free time.

[papametis]

Would you like to contribute a PR to add this?

Hello, I have added this option in my code. Could I do a pull request to add it over here?

Also, this is my first time contributing to this project and OSS in general, so I wanted to ask just for clarity: I have added test coverage for this new option, as well as a description for the --help documentation, but is there more I need to do to ensure the PR is "complete" (as described in the intro.md doc)?

[Lucas-C]

Hi @papametis 🙂 👋

Hello, I have added this option in my code. Could I do a pull request to add it over here?

Yes sure, this would be welcome, thanks for proposing your help!

Also, this is my first time contributing to this project and OSS in general, so I wanted to ask just for clarity: I have added test coverage for this new option, as well as a description for the --help documentation, but is there more I need to do to ensure the PR is "complete" (as described in the intro.md doc)?

Great, congratulations on making your first OSS contribution! 🎉

I think you are good to submit a PR.
There is a list of things to include in it:

• the code of the new feature
• some unit tests covering its behaviour
• a mention of this addition in CHANGELOG.md
• some usage example / documentation about it in docs/user/
• when the PR is created, code-checking tools like blackor ruff will be executed. If they report failures in the GitHub Actions pipeline, please fix the related issues by then adding commits to your branch. You can also run black or ruff locally on your computer.

Tell me if you have any other question, and have fun with your first PR! 🙂

[papametis]

Thank you for the helpful reply! 😄 I still have a couple of questions, maybe too nitpicky, but I am trying to do this as properly as I can, so I would appreciate any help you're willing to lend me:

• a mention of this addition in CHANGELOG.md

Should I mention the addition as part of a newer v0.5.2? Or as part of the current latest version 0.5.1?

• some usage example / documentation about it in docs/user/

From what I understand, usage examples have some exemplary input and output for the command at question. In my case, in the command's output, the way I have implemented it, the chosen output directory is printed. However I am currently using a Windows computer (using PowerShell for my tests and all), so directories include the drive and backslashes, but Linux uses forward slashes and no drives, so I am wondering how to format the directory printed by the command, when it comes to the usage example. Should I opt for a Linux-esque output from this command when writing my usage example, or if there is some sort of other way I can write up the usage example that ensures the exemplary output in the doc is "universal".

Thanks in advance!