m1stadev / PyIMG4

A Python library/CLI tool for parsing Apple's Image4 format.
MIT License
48 stars 8 forks source link

Please update README with usage examples #4

Closed doronz88 closed 2 years ago

doronz88 commented 2 years ago

Hi!

I didn't quite understand how am I supposed to use it to parse a given .im4p image. I saw the examples folder but I believe it should be available from the main CLI. BTW, I recommend using click to parse the subcommands and arguments.

If you'd like, I can develop part of the CLI according to what you see fit.

m1stadev commented 2 years ago

Sorry for the late response, only now seeing this. I'll address some of the different things in this issue.

I saw the examples folder but I believe it should be available from the main CLI.

A CLI tool is one of the main things that PyIMG4 still needs before I release a 1.0 version, and I've admittedly put it on the back-burner. I've begun work on a basic CLI tool, but still has a long way to go before being ready to be pushed to the repo.

BTW, I recommend using click to parse the subcommands and arguments.

I'm not against using click, but I'd prefer to implement it without adding it as an extra dependency, and instead using something like argparse

If you'd like, I can develop part of the CLI according to what you see fit.

Honestly, if you'd be willing I'd greatly appreciate this. I'd prefer the arguments to be similar to either img4tool or img4lib, but if you have any other ideas for writing the CLI tool then I'm all ears.