high level overview about pluggy HOT 20 CLOSED

@hpk42 yeah I know I kinda dropped the ball on this...been busy.

It's Pycon Canada this weekend in Toronto so I'll try to jam something out at the very least during the sprints Mon-Tues.

from pluggy.

actually, let me just do a quick and dirty initial setup with only api docs

from pluggy.

1/2) both setuptools entrypoints and custom loading are upported
3) all added plugins are constructed instances or modules,
the typical method to do global initialization is to create a historic configuration hook that
gets called on each added plugin (like pytest_configure)

from pluggy.

1/2) both setuptools entrypoints and custom loading are upported

This explanation is no better than "as used by py.test". =)

3. what is "global" initialization and what is "normal" initialiation in this case?

from pluggy.

there is no "normal"

you'd just have a hook thats called on all plugins that get registered in all variants it was called with

there is a reason why i strongly referred to pytest internal usages,
we are rather short on time atm
n

from pluggy.

@techtonik one of the milestones for a pluggy 1.0 release is complete docs, which as @RonnyPfannschmidt said probably won't be available in the short term.

We should use this issue to remember ourselves of the need for better documentation on pluggy.

from pluggy.

I see.

you'd just have a hook thats called on all plugins that get registered in all variants it was called with

Before a hook is called on a plugin, you need to find and import that plugin. Is that "hook" is just a function that should be implemented by a module as a part of plugin interface?

from pluggy.

Yes, the pytest_configure hook in pytest is one such example

from pluggy.

Ok. hooks == plugin api == plugin callbacks. Thanks for the explanations.

from pluggy.

Hello, I'm in the process of implementing plugins using pluggy in our own application. Is there a more elaborate description of how to use pluggy? When can pluggy 1.0 be expected? When can pytest 3 be expected?

from pluggy.

When can pluggy 1.0 be expected?

Not sure, @hpk42 could comment on that.

When can pytest 3 be expected?

I would say sometime after our sprint, which will end on June 25th.

from pluggy.

@nicoddemus @RonnyPfannschmidt @hpk42 I'd be willing to take a stab at this.

I've now used pluggy in another small project and also have pretty decent experience with pytest at this point. I also have combed the pluggy source code multiple times and am pretty sure I have a decent grasp of the internals. I've been trying to use pluggy as a means to learn pytest from the bottom up for some time now but I need some deadlines to move it along.

I'd be willing to submit a PR for sphinx docs within the next few weeks. My only request is that eventually this project is moved to the pytest-dev org and maintained more prominently there.

from pluggy.

I did send @hpk42 a mail about that
He will react after returning from his current travel

from pluggy.

My personal opinion is that I certainly would love to have some docs for the project! I would also like to move it to pytest-dev, but let's see what @hpk42 has to say about that.

from pluggy.

@RonnyPfannschmidt @nicoddemus well it looks like we got our wish!

Are you guys cool with sphinx + the alabaster theme to start?

from pluggy.

Hey @tgoodlet! 😁

I think Sphinx is fine, but if you don't mind I would rather publish to readthedocs with the default readthedocs theme. What do you think?

from pluggy.

@nicoddemus sure works for me. I'll get something cobbled together in the next week or so and link you guys.

from pluggy.

Nice, sounds good! Thanks a lot for your interest, it is really appreciated by the team! 👍

Btw, already created the project on readthedocs. 😁

from pluggy.

I'd be very happy with a sphinx project even by just having nice API online documentation. @tgoodlet if you go for this we could eventually go for pluggy-1.0 i think 👍

from pluggy.

@RonnyPfannschmidt so are you going to push up just a sphinx autodoc draft?

I'm a fan of you getting the rtd build up and running since I don't have access currently ;)

from pluggy.