feat: make package/module callable

[jkowalleck]

fixes #321

[madpah]

Hey @jkowalleck - like the idea. Thanks for the PR.

Can you also add a documentation update to explain this new invocation method as per #321 ?

Also - would we consider this a breaking change given PEP-3102 syntax has been added?

[jkowalleck]

Sure, will add docs in the readme and other places.

Re: breaking change.
My intention was to add optional params to existing public api, so full backwards compatibility is given. Will check if I can improve the implementation.
Do you have any advice? Could you share your thoughts, @madpah ?

[jkowalleck]

actually, i do not have any idea where i could document the call via python -m. Please point me to it, @madpah .

regarding "is this a breaking change?"
A: nope, it still adds optional parameters to existing methods. No issue with backwards-compatibility, as the functionality is optional and usage is self-contained.

[madpah]

@jkowalleck - I've added Documentation to CONTRIBUTING.md now - let me know if that is not enough to pop in some documentation changes.

Thanks on confirming NO breaking change 👍

[jkowalleck]

Thanks, @madpah .
I still do not know where to document alternative call methods.
I see https://github.com/CycloneDX/cyclonedx-python/blob/master/docs/usage.rst talking about the params and such. and is points out to call cyclonedx-bom. But where is the note that cyclonedx-py for example is an alternative call method? I would add the python -m cyclonedx-py at the exact same spot.

Could you point me to the spot i could update, @madpah ? I can't see the forest for the trees.

[jkowalleck]

added the missing docs. made creative modification in the "usage" section, as this is the related topic.

is this fine, @madpah ?

[jkowalleck]

@madpah please have a look at the proposed changes of this PR