Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add plugin to Flask Extensions page #11

Open
9 of 10 tasks
iurisilvio opened this issue Apr 1, 2014 · 6 comments
Open
9 of 10 tasks

Add plugin to Flask Extensions page #11

iurisilvio opened this issue Apr 1, 2014 · 6 comments
Labels

Comments

@iurisilvio
Copy link
Contributor

  • An approved Flask extension requires a maintainer. In the event an extension author would like to move beyond the project, the project should find a new maintainer including full source hosting transition and PyPI access. If no maintainer is available, give access to the Flask core team.
  • An approved Flask extension must provide exactly one package or module named flask_extensionname. They might also reside inside a flaskext namespace packages though this is discouraged now.
  • It must ship a testing suite that can either be invoked with make test or python setup.py test. For test suites invoked with make test the extension has to ensure that all dependencies for the test are installed automatically. If tests are invoked with python setup.py test, test dependencies can be specified in the setup.py file. The test suite also has to be part of the distribution.
  • APIs of approved extensions will be checked for the following characteristics:
    an approved extension has to support multiple applications running in the same Python process.
    it must be possible to use the factory pattern for creating applications.
  • The license must be BSD/MIT/WTFPL licensed.
  • The naming scheme for official extensions is Flask-ExtensionName or ExtensionName-Flask.
  • Approved extensions must define all their dependencies in the setup.py file unless a dependency cannot be met because it is not available on PyPI.
  • The extension must have documentation that uses one of the two Flask themes for Sphinx documentation.
  • The zip_safe flag in the setup script must be set to False, even if the extension would be safe for zipping.
  • An extension currently has to support Python 2.6 as well as Python 2.7
@mikeboers
Copy link
Owner

Do you know how one goes about doing this? =P

@iurisilvio
Copy link
Contributor Author

You have to pull request your extension is Flask Extensions Registry. Flask has some docs about how to approve the extension.

http://flask.pocoo.org/docs/extensiondev/#approved-extensions

@iurisilvio
Copy link
Contributor Author

I copied the guidelines to approved extensions in the issue to make it happen.

You can add it to the registry even without it, but it will not have the approved extension flag.

@mikeboers
Copy link
Owner

Looks like it is down to the docs theme, and a little bit more testing...

@iurisilvio
Copy link
Contributor Author

So, you just have to publish the docs.

All other requirements are ok.

@mikeboers
Copy link
Owner

At some point in recent history I translated the existing docs from Markdown to Sphinx. They are still kinda gross, but there they are.

What do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants