How to add a custom Processor

[melMass]

Hi Niklas!

What steps should be taken to add a processor?

For now I called the processor images defined it in pydoc_markdown.contrib.processors.images:ImagesProcessor.

I added it to both the setup.py's pydoc_markdown.interfaces.Processor as

images = pydoc_markdown.contrib.processors.images:ImagesProcessor

and the PydocMarkdown.processors's default_factory.

For now, I just print in all interfaces to understand the flow of it all, but when I add it to my config I have the ModuleNotFoundError: No module named 'images'

[NiklasRosenstein]

Hey @melMass !

This sounds good, it might be that you are missing a re-install of the package after updating the setup.py file?

Please note that the setup.py file is generated from the package.yml file with Shut. A simple change like this doesn't require you to use Shut if you keep the changes for the two files in sync,, though. Just make sure that for the PR you also update the package.yml file 🙂

Cheers,

[melMass]

Oh I see, it might be that I use it as a local develop package like this:

pydoc-markdown = { path = "/Users/mel/gits/CONTRIBS/pydoc-markdown", develop = true }

I'm not sure how the setup.py is handled by Poetry in this case, I will check.
Thanks for the confirmation. I'll drop other related questions here!

ps: I'll check Shut, it looks very neat

[NiklasRosenstein]

That's fine, but entry points are not automatically refreshed, they are "hard" installed even in develop mode afaik. So just make sure the package is reinstalled (e.g. with pip install -e .) and you should be golden!

[melMass]

Yes! poetry run pip install -e "/path/to/pydoc-markdown" works

[melMass]

Seing this with fresh eyes, python -m pydoc-markdown <args> might be easier to keep it in dev mode in Poetry.

Anyway! As explained in the issue, I'm back to it .... and of course I need this image processor 😅 !
So just letting you know that I'm diving into this again ;)