add documentation regarding the plugin creation and create a create plugin template

sparckles / Robyn

Robyn is a Super Fast Async Python Web Framework with a Rust runtime.

https://robyn.tech/

BSD 2-Clause "Simplified" License

3.95k stars 203 forks source link

add documentation regarding the plugin creation and create a create plugin template #686

Open sansyrox opened 8 months ago

13Mai13 commented 4 months ago

Could you give some more context here? I'm happy to contribute

sansyrox commented 4 months ago

Hey @13Mai13 👋

Thank you! 😄

There are plugins like this(https://github.com/IdoKendo/robyn_rate_limits) and we would love to add some documentation around the creation process.

And in addition to this, I was thinking of adding a scaffold repo, which would allow the developer to start a repo using a command like robyn --create-plugin and then create a base project.

13Mai13 commented 4 months ago

I've started working on this. I've got a couple questions:

What are the minimum requirements for a plugin to work? Maybe you have something written down which could assist?
When passing robyn --create-plugin do we want to pass a name or do we just keep it as an example default?
When a developer runs --create-plugin, what did you envision would be the steps of operation? Having your thought process on this will make it easier for me to document and implement this