docs: design documents and flow diagram

[loneshark99]

Hello,

This is a request not a issue. Can you please share the design doc /internals for this library. How the calls are hooked and how to learn to create this kind of library.

Thanks for the help.

Thanks.

[mharrisb1]

Hey @loneshark99 I'd be happy to add that. It's of course going to be a little low on the priority list but I think it's reasonable to have to help encourage contributions.

I'm also in the middle of a big refactor to v0.3.0 to support streaming (#3) so I'll definitely need to wait for that to be released since everything would change so much from now to then.

Are you more interested in design docs for how this particular package works or how you could create a pytest plugin for any API such as Salesforce, Notion, Slack, etc.?

[loneshark99]

Hi @mharrisb1,

Thanks for the reply, Yes, I was just wondering the design of this particular package. Just some high level diagram with how you hook into other frameworks etc, would be very helpful. I am more from c# background and trying to get deeper into python development.

Thanks for sharing this package.