Django-rest-framework: Live API docs (#4755) makes `markdown` dependency non-optional

[carltongibson]

rest_framework.templatetags.rest_framework is non-conditionally importing markdown.

from markdown.extensions.fenced_code import FencedBlockPreprocessor

from rest_framework.compat import (
    NoReverseMatch, markdown, reverse, template_render
)

https://github.com/tomchristie/django-rest-framework/blob/master/rest_framework/templatetags/rest_framework.py#L12-L16

As per the compat import markdown has previously been an optional dependency. It's still listed as an optional requirement

Without markdown installed, the template tags can no longer be imported. cf https://github.com/carltongibson/django-filter/pull/658

Markdown either needs to be declared required or a work around is needed.

[tomchristie]

👍 blocker for 3.6

[tomchristie]

We don't really need that extension - it was more of a hangover from first pass at building the API docs. I've removed it for now - if we do add any markdown extensions to it we can make sure to do so in an optional dependency manner.

[intgr]

The "fix" for this issue was insufficient. Note the line in templatetags/rest_framework.py:

from rest_framework.compat import (
    NoReverseMatch, markdown, pygments_highlight, reverse, template_render
)

This unconditionally tries to import the name markdown, however, compat.py has this code:

# Markdown is optional
try:
    import markdown

    ...
except ImportError:
    apply_markdown = None

The name markdown that templatetags attempts to import won't be defined if import markdown fails -- only apply_markdown is. Therefore it still causes the exception on import: django.template.library.InvalidTemplateLibrary: Invalid template library specified. ImportError raised when trying to load 'rest_framework.templatetags.rest_framework': cannot import name 'markdown'

[tomchristie]

Thanks @intgr - I'll take a look at addressing that now.

[micheledallatorre]

Hello,
I tried following the quickstart (http://www.django-rest-framework.org/tutorial/quickstart/) but I get the following error.

InvalidTemplateLibrary at /
Invalid template library specified. ImportError raised when trying to load 'rest_framework.templatetags.rest_framework': cannot import name markdown

How to fix that?

Thanks.

[tomchristie]

@micheledallatorre - Should be resolved as of just now. Upgrade to 3.6.1 (Or install the markdown library and stick with 3.6.0)

[micheledallatorre]

Thank you.
Running pip install django-markdown solved the issue.

[sakshij]

@tomchristie I am on 3.6.2 and still getting this error. When I added django markdown to requirements, this got resolved but I started getting a different error when trying to run celery -
django.core.management.base.CommandError: Unknown command: 'syncdb'

[Dziugas]

@tomchristie I am on python 3.6.1, have markdown installed and still get the following error:

Invalid template library specified. ImportError raised when trying to load 'rest_framework.templatetags.rest_framework': No module named 'django.urls'

[carltongibson]

What Django version are you running?

[Dziugas]

@carltongibson I'm using Django 1.9.0

[carltongibson]

Django 1.9 is End of Life and no-longer supported. You should upgrade to Django 1.11 LTS or Django 2.0

[Dziugas]

thanks, @carltongibson, I installed Django 2.0, it now works.