search

noirbizarre / flask-restplus

Fully featured framework for fast, easy and documented API development with Flask
http://flask-restplus.readthedocs.org
Other
2.74k stars 506 forks source link

explain about the fork #769

Closed ziirish closed 4 years ago

ziirish commented 4 years ago

Let the community know about the fork and give some context.

cc. @j5awry, @SteadBytes

coveralls commented 4 years ago

Coverage Status

Coverage increased (+0.09%) to 96.923% when pulling 93899648004f60c1bdfd29e5ea42e8708d8fead8 on fork into 9232e1a6599621e97223e1915c9b414c92faf2cc on master.

SteadBytes commented 4 years ago

Thanks for putting this together @ziirish this is great. I'm just wondering if it might be beneficial to re-arrange slightly and start with the fork notice. This makes it immediately obvious that this project should be considered unmaintained and that the new fork is where ongoing development will take place. The explanation of why could then follow :) Something like this perhaps?

IMPORTANT NOTICE:

This project has been forked to flask-restx and will be maintained by by the python-restx organization. Flask-RESTPlus should be considered unmaintained.

The community has decided to fork the project due to lack of response from the original author @noirbizarre. We have been discussing this eventuality for almost a year.

Things evolved a bit since that discussion and a few of us have been granted maintainers access to the github project, but only the original author has access rights on the PyPi project. As such, we been unable to make any actual releases. To prevent this project from dying out, we have forked it to continue development and to support our users.

ziirish commented 4 years ago

Thanks for the review.

I'll update the README accordingly to your version which I prefer over mine :)

SteadBytes commented 4 years ago

Awesome thank you for taking the feedback on board! 😊

Would you mind fixing up those extra couple of commits into the first one? Just to keep the history cleaner, then we should merge! 🎉

ziirish commented 4 years ago

done

rogeriolino commented 4 years ago

Congrats guys. These project must (still) be maintaned.

But, what about the new name?

ziirish commented 4 years ago

@rogeriolino I'm not sure to understand your question.

We have added the links to the fork in the README and I opened and pinned an issue with all the informations: #770

What would you like to know?

rogeriolino commented 4 years ago

@ziirish is about the org/project suffix restx.

I was following the #743 issue, where forks naming was suggested, and I dont read about the these new name.

Just for curiosity.

Regards

ziirish commented 4 years ago

So you want to know why we chose restx?

I'm thinking of adding the reason in flask-restx' README at some point. The idea comes from a discussion on the gitter channel. It's a proposal of @apryor6.

flask-restx as an 'x' is just like a '+', with a twist :)

Most of us liked the idea, hence the new name.

The discussion is here.