Added extension registry

This commit is contained in:
Armin Ronacher 2010-05-09 14:08:02 +02:00
parent aeb3d32132
commit a2fe635dd8
8 changed files with 148 additions and 1 deletions

View file

@ -0,0 +1,38 @@
{% extends "extensions/layout.html" %}
{% block title %}Creating Extensions{% endblock %}
{% block body %}
<h2>Creating Extensions</h2>
<p>
Extensions to Flask are regular Python packages. But there are some
rules you should/must follow so that we can enlist your extension on
the Flask extension registry:
<ol>
<li>
Your extension must be placed in a <code>flaskext.</code>
namespace package. This makes it easier for others to locate
your extension and does not clutter the PyPI index with generic
toplevel packages.
<li>
Your extension should have the word “Flask” in the name. This
makes it easier to locate all the packages that go well with
Flask. This is also how the moderators of the extension registry
spot your extension.
<li>
The extension should be documented with Sphinx and it's recommended
to use intersphinx to interlink the documentation with Flask itself
and other extensions it might depend on. It's also recommended to use
the <a href="http://github.com/mitsuhiko/flask-sphinx-themes">Flask
Sphinx Themes</a> or a modified version of one of them.
<li>
Extensions should have proper dependencies in the <em>setup.py</em>
file specified so that installation with pip/easy_install works.
<li>
Ideally your extension has at least one example in the repository
or tarball so that it's easier to understand how it works.
</ol>
<p>
We scan the PyPI index in regular intervals for new Flask packages
so your extension should sooner or later end up here. If this is
not quick enough for you, send <a
href="mailto:armin.ronacher@active-4.com">me a mail</a>.
{% endblock %}

View file

@ -0,0 +1,36 @@
{% extends "extensions/layout.html" %}
{% block title %}Extensions Registry{% endblock %}
{% block body %}
<p>
Welcome to the Flask extensions registry. Here you can find a list
of packages that extend Flask. This list is moderated and updated
on a regular basis. If you want your package to show up here,
follow the <a href="{{ url_for('creating') }}">guide on creating
extensions</a>.
{% for extension in extensions %}
<div class=extension>
<h2>{{ extension.name }}</h2>
<div class=description>
{{ extension.description }}
</div>
<dl>
<dt>Author:
<dd>{{ extension.author }}
<dt>PyPI Page:
<dd><a href="{{ extension.pypi }}">{{ extension.name }}</a>
{% if extension.website %}
<dt>Website:
<dd>{{ extension.website|urlize }}
{% endif %}
{% if extension.docs %}
<dt>Documentation:
<dd><a href="{{ extension.docs }}">Read docs @ {{ extension.docserver }}</a>
{% endif %}
{% if extension.github %}
<dt>On Github:
<dd><a href="http://github.com/{{ extension.github }}">{{ extension.github }}</a>
{% endif %}
</dl>
</div>
{% endfor %}
{% endblock %}

View file

@ -0,0 +1,10 @@
{% extends "layout.html" %}
{% block head %}
{{ super() }}
<style type=text/css>
h1 { background-image: url(/static/extensions.png); }
</style>
{% endblock %}
{% block body_title %}
<h1><span>Flask Extensions</span></h1>
{% endblock %}

View file

@ -14,7 +14,8 @@
<a href=/>overview</a> //
<a href=/docs/>documentation</a> //
<a href=/mailinglist/>mailinglist</a> //
<a href=/snippets/>snippets</a>
<a href=/snippets/>snippets</a> //
<a href=/extensions/>extensions</a>
{% for message in get_flashed_messages() %}
<p class=message>{{ message }}
{% endfor %}