Add Markdown support

Fixes: GH-1

Author: msabramo

readme/markdown.py

@@ -0,0 +1,23 @@
+# Copyright 2014 Donald Stufft
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import absolute_import, division, print_function
+
+import markdown
+
+from .clean import clean
+
+
+def render(raw):
+    rendered = markdown.markdown(raw)
+    return clean(rendered or raw), bool(rendered)

setup.py

@@ -62,6 +62,7 @@
     install_requires=[
         "bleach",
         "docutils",
+        "markdown",
         "Pygments",
         "six",
     ],

tests/test_markdown.py

@@ -0,0 +1,107 @@
+import textwrap
+
+from readme.markdown import render
+
+
+def test_markdown_001():
+    markdown_markup = 'Hello'
+    out, rendered = render(markdown_markup)
+    assert rendered
+    assert out == '<p>Hello</p>'
+
+
+def test_markdown_002():
+    markdown_markup = textwrap.dedent("""\
+        # Required packages
+        To run the PyPI software, you need Python 2.5+ and PostgreSQL
+        # Quick development setup
+        Make sure you ...""")
+    expected_html = textwrap.dedent("""\
+        <h1>Required packages</h1>
+        <p>To run the PyPI software, you need Python 2.5+ and PostgreSQL</p>
+        <h1>Quick development setup</h1>
+        <p>Make sure you ...</p>""")
+    out, rendered = render(markdown_markup)
+    assert rendered
+    assert out == expected_html
+
+
+def test_markdown_003():
+    markdown_markup = textwrap.dedent("""\
+        Then, you can create a *development environment* like this,
+        if you have **virtualenv** installed:
+
+            $ virtualenv --no-site-packages .
+            $ pip install -r requirements.txt
+
+        Then you can launch the server using the `pypi.wsgi` script:
+
+            $ python pypi.wsgi
+            Serving on port 8000...
+
+        PyPI will be available in your browser at http://localhost:8000
+    """)
+    expected_html = '\n'.join([
+        '<p>Then, you can create a <em>development environment</em> '
+        'like this,',
+        'if you have <strong>virtualenv</strong> installed:</p>',
+        '<pre><code>$ virtualenv --no-site-packages .',
+        '$ pip install -r requirements.txt',
+        '</code></pre>',
+        '<p>Then you can launch the server using the '
+        '<code>pypi.wsgi</code> script:</p>',
+        '<pre><code>$ python pypi.wsgi',
+        'Serving on port 8000...',
+        '</code></pre>',
+        '<p>PyPI will be available in your browser at '
+        'http://localhost:8000</p>'])
+    out, rendered = render(markdown_markup)
+    assert rendered
+    assert out == expected_html
+
+
+def test_markdown_004():
+    markdown_markup = 'http://mymalicioussite.com/'
+    out, rendered = render(markdown_markup)
+    expected_html = '<p>http://mymalicioussite.com/</p>'
+    assert rendered
+    assert out == expected_html
+
+
+def test_markdown_005():
+    markdown_markup = '<a href="http://mymalicioussite.com/">Click here</a>'
+    out, rendered = render(markdown_markup)
+    expected_htmls = [
+        ''.join(['<p><a rel="nofollow" href="http://mymalicioussite.com/">',
+                 'Click here</a></p>']),
+        ''.join(['<p><a href="http://mymalicioussite.com/" rel="nofollow">',
+                 'Click here</a></p>']),
+    ]
+    assert rendered
+    assert out in expected_htmls
+
+
+def test_markdown_006():
+    markdown_markup = """\
+        <iframe src="http://mymalicioussite.com/">Click here</iframe>
+    """.strip()
+    out, rendered = render(markdown_markup)
+    expected_html = ''.join([
+        '&lt;iframe src="http://mymalicioussite.com/"&gt;'
+        'Click here&lt;/iframe&gt;'])
+    assert rendered
+    assert out == expected_html
+
+
+def test_markdown_007():
+    markdown_markup = textwrap.dedent("""\
+        <script>
+            alert("Hello");
+        </script>""")
+    out, rendered = render(markdown_markup)
+    expected_html = textwrap.dedent("""\
+        &lt;script&gt;
+            alert("Hello");
+        &lt;/script&gt;""")
+    assert rendered
+    assert out == expected_html