Lancetnik / Propan

Propan is a powerful and easy-to-use Python framework for building event-driven applications that interact with any MQ Broker
https://lancetnik.github.io/Propan/
MIT License
485 stars 28 forks source link

Docs typo fixes #97

Closed tatzati closed 1 year ago

tatzati commented 1 year ago

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.

Going throw the documentation and decided to contribute to the docs.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

Checklist

Lancetnik commented 1 year ago

@tatzati thx a lot for your help! Do you have any planes to contribute again later? This kind of contribution is the best!

tatzati commented 1 year ago

@Lancetnik hey there! I am looking for a nice project to contribute, and I found this one through r/opensource. I was looking at the docs to figure out what this was about, and thought I would land a help while doing so. I have about seven years of experience with python mostly on django and flask, and regarding messaging systems I have only used rabbitmq to broker tasks to celery and a little bit of kafka in some cases, but nothing much outside of that. I would like to learn more about this project and see if I can contribute more to the codebase. If possible, I would very much appreciate someone to mentor me on the current state of the project and prepare me to be able to contribute as much as I can. Cheers!

Lancetnik commented 1 year ago

@tatzati I am happy to see a developer with your experience ready to go deeper into the project. Don't worry about messaging - you will quickly fall in.

The core project architecture you can find here and specific broker implementation is described as well. So, you can check the code and the doc to be familiar with "how it works".

The main direction right now: build a sync project version (to be compatible with django/flask) and ZeroMQ support (brokerless pub/sub should be an extremely helpful tool for many python backend developers), also I am working on better AsyncAPI integration (you can check the spec and integrate more fields to Propan application, but it's not your level task, I suppose)