Markdown

MANIFEST.in

@@ -4,4 +4,5 @@ include tox.ini .coveragerc
 recursive-include tests *.html
 recursive-include tests *.py
 recursive-include tests *.rst
+recursive-include tests *.md
 recursive-include tests *.txt

readme_renderer/base.py

@@ -0,0 +1,29 @@
+# Copyright 2017 Julien Palard
+#
+# 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 mdorrst
+
+from .rst import render as rst_renderer
+from .markdown import render as md_renderer
+from .txt import render as txt_renderer
+
+RENDERERS = {'rst': rst_renderer,
+             'md': md_renderer,
+             'txt': txt_renderer}
+
+
+def render(raw):
+    sniffed_format = mdorrst.sniff(raw)
+    return RENDERERS[sniffed_format](raw) or txt_renderer(raw)

readme_renderer/markdown.py

@@ -0,0 +1,34 @@
+# 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):
+    try:
+        rendered = markdown.markdown(
+            raw,
+            extensions=[
+                'markdown.extensions.codehilite',
+                'markdown.extensions.fenced_code',
+                'markdown.extensions.smart_strong',
+            ])
+    except ValueError:
+        # Markdown failed to strip top-level tags.
+        return None
+    else:
+        return clean(rendered)

setup.py

@@ -60,10 +60,12 @@
     ],
 
     install_requires=[
+        "markdown>=2.6.8",
         "bleach>=2.0.0",
         "docutils>=0.13.1",
         "Pygments",
         "six",
+        "mdorrst>=0.4.0"
     ],
 
     entry_points={

tests/fixtures/markdown/code.html

@@ -0,0 +1,16 @@
+<p>Here is some Python:</p>
+<div><pre><span></span><span class="kn">import</span> <span class="nn">os</span>
+
+<span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
+    <span class="k">return</span> <span class="nb">open</span><span class="p">(</span><span class="n">fn</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
+</pre></div>
+
+
+<p>And some more with the commonly used short <em>py</em> mark:</p>
+<div><pre><span></span><span class="ch">#!/usr/bin/env python3</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">setuptools</span>
+
+<span class="n">base_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)</span>
+</pre></div>

tests/fixtures/markdown/code.md

@@ -0,0 +1,19 @@
+Here is some Python:
+
+```python
+import os
+
+def read(fn):
+    return open(fn).read()
+```
+
+And some more with the commonly used short *py* mark:
+
+```py
+#!/usr/bin/env python3
+
+import os
+import setuptools
+
+base_dir = os.path.dirname(__file__)
+```

tests/fixtures/markdown/headings_and_paragraphs.html

@@ -0,0 +1,4 @@
+<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>

tests/fixtures/markdown/headings_and_paragraphs.md

@@ -0,0 +1,6 @@
+# Required packages
+
+To run the PyPI software, you need Python 2.5+ and PostgreSQL
+
+# Quick development setup
+Make sure you ...

tests/fixtures/markdown/misc.html

@@ -0,0 +1,14 @@
+<p>Then, you can create a <em>development environment</em> like this,
+if you have <strong>virtualenv</strong> installed:</p>
+<div><pre><span></span>$ virtualenv --no-site-packages .
+$ pip install -r requirements.txt
+</pre></div>
+
+
+<p>Then you can launch the server using the <code>pypi.wsgi</code> script:</p>
+<div><pre><span></span>$ python pypi.wsgi
+Serving on port <span class="m">8000</span>...
+</pre></div>
+
+
+<p>PyPI will be available in your browser at http://localhost:8000</p>

tests/fixtures/markdown/misc.md

@@ -0,0 +1,12 @@
+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

tests/test_base.py

@@ -0,0 +1,45 @@
+import io
+import glob
+import os.path
+
+import pytest
+
+from readme_renderer.base import render
+
+
+@pytest.mark.parametrize(
+    ("src_filename", "html_filename"),
+    [
+        (fn, os.path.splitext(fn)[0] + ".html")
+        for fn in glob.glob(
+            os.path.join(os.path.dirname(__file__),
+                         "fixtures", "test_*.rst")
+        ) + glob.glob(
+            os.path.join(os.path.dirname(__file__),
+                         "fixtures", "markdown", "*.md")
+        )
+    ],
+)
+def test_base_fixtures(src_filename, html_filename):
+    too_short = {
+        'misc.md',
+        'test_rst_004.rst',
+        'test_rst_005.rst',
+        'test_rst_006.rst',
+        'test_rst_007.rst'}
+    if os.path.basename(src_filename) in too_short:
+        """sniff won't match in any cases for those files being too short
+        tests to be sniffed correctly (like just an "<a href", or just
+        a <script>alert("Hello")</script>) """
+        return
+    # Get our Markup
+    with io.open(src_filename, encoding='utf-8') as f:
+        markup = f.read()
+
+    # Get our expected
+    with io.open(html_filename, encoding="utf-8") as f:
+        expected = f.read()
+
+    out = render(markup)
+
+    assert out.rstrip() == expected.rstrip()

tests/test_markdown.py

@@ -0,0 +1,86 @@
+import io
+import os
+import textwrap
+
+from readme_renderer.markdown import render
+
+
+def test_simple():
+    markdown_markup = 'Hello'
+    out = render(markdown_markup)
+    assert out == '<p>Hello</p>'
+
+
+def test_url_no_link():
+    markdown_markup = 'http://mymalicioussite.com/'
+    out = render(markdown_markup)
+    expected_html = '<p>http://mymalicioussite.com/</p>'
+    assert out == expected_html
+
+
+def test_iframe():
+    markdown_markup = """\
+        <iframe src="http://mymalicioussite.com/">Click here</iframe>
+    """.strip()
+    out = render(markdown_markup)
+    expected_html = ''.join([
+        '&lt;iframe src="http://mymalicioussite.com/"&gt;'
+        'Click here&lt;/iframe&gt;'])
+    assert out == expected_html
+
+
+def test_script():
+    markdown_markup = textwrap.dedent("""\
+        <script>
+            alert("Hello");
+        </script>""")
+    out = render(markdown_markup)
+    expected_html = textwrap.dedent("""\
+        &lt;script&gt;
+            alert("Hello");
+        &lt;/script&gt;""")
+    assert out == expected_html
+
+
+def test_a_tag_gets_nofollow():
+    markdown_markup = '<a href="http://mymalicioussite.com/">Click here</a>'
+    out = 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 out in expected_htmls
+
+
+def test_smart_strong():
+    markdown_markup = 'Text with double__underscore__words.'
+    out = render(markdown_markup)
+    expected_html = '<p>Text with double__underscore__words.</p>'
+    assert out == expected_html
+
+
+def test_github_backtick_syntax_for_code():
+    _do_test_with_files('code')
+
+
+def test_headings_and_paragraphs():
+    _do_test_with_files('headings_and_paragraphs')
+
+
+def test_misc():
+    _do_test_with_files('misc')
+
+
+def _do_test_with_files(test_name):
+    md_markup = read('{0}.md'.format(test_name))
+    expected_html = read('{0}.html'.format(test_name))
+    out = render(md_markup)
+    assert out == expected_html.rstrip()
+
+
+def read(fn):
+    path = os.path.join(os.path.dirname(__file__), 'fixtures', 'markdown', fn)
+    with io.open(path, encoding='utf-8') as f:
+        return f.read()