{"id":24154,"library":"openedx-django-wiki","title":"Open edX Django Wiki","description":"A wiki system for Django, forked and maintained by Open edX. Current version is 3.1.1. It supports Django 3.2 to 4.2 and Python 3.8 to 3.11. Active development with irregular releases.","status":"active","version":"3.1.1","language":"python","source_language":"en","source_url":"https://github.com/openedx/django-wiki","tags":["wiki","django","openedx","content-management","markdown"],"install":[{"cmd":"pip install openedx-django-wiki","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Required framework","package":"Django","optional":false}],"imports":[{"note":"In old versions, get_pattern was mistakenly imported from wiki. Use wiki.urls.","wrong":"from wiki import get_pattern","symbol":"wiki","correct":"from wiki.urls import get_pattern as get_wiki_pattern"},{"note":"The decorators module moved from wiki.core.decorators to wiki.decorators in v2.","wrong":"from wiki.core.decorators import WikiDecoratorMixin","symbol":"WikiDecoratorMixin","correct":"from wiki.decorators import WikiDecoratorMixin"}],"quickstart":{"code":"import django\nfrom django.conf import settings\nsettings.configure(\n    DATABASES={'default': {'ENGINE': 'django.db.backends.sqlite3', 'NAME': ':memory:'}},\n    INSTALLED_APPS=[\n        'django.contrib.contenttypes',\n        'django.contrib.auth',\n        'django.contrib.sessions',\n        'django.contrib.admin',\n        'wiki',\n        'wiki.plugins.attachments',\n        'wiki.plugins.notifications',\n        'wiki.plugins.links',\n        'wiki.plugins.macros',\n        'django_nyt',\n        'mptt',\n        'sekizai',\n    ],\n    ROOT_URLCONF='wiki.urls',\n)\ndjango.setup()\nfrom wiki.urls import get_pattern\nurlpatterns = [get_pattern()]\nprint('Wiki app configured successfully')","lang":"python","description":"Minimal Django configuration to verify the wiki app can be imported and URL patterns generated."},"warnings":[{"fix":"Ensure you are using Django >=4.0 or upgrade to v2.1.0+ for Python 3.11.","message":"From v2.0.0, support for Django 3.2 was dropped. Python 3.11 was added in v2.1.0. If upgrading from v1.x, check your Django version compatibility.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Review your bleach configuration if you rely on specific allowed tags or attributes.","message":"In v2.0.0, the bleach library was updated, which may affect HTML sanitization in wiki content. Custom white-lists may need adjustment.","severity":"breaking","affected_versions":"2.0.0"},{"fix":"Install 'openedx-django-wiki' but import as 'from wiki import ...'.","message":"The package name on PyPI is 'openedx-django-wiki', but the module is still 'wiki'. Do not confuse with the older 'django-wiki' package by benjaoming.","severity":"gotcha","affected_versions":"all"},{"fix":"Remove 'wiki.plugins.images' from INSTALLED_APPS and migrate any image content.","message":"From v3.1.0, the wiki.plugins.images plugin has been removed. Use attachments or macros instead.","severity":"deprecated","affected_versions":"3.1.0+"},{"fix":"Upgrade Django to 4.0, 4.1, or 4.2.","message":"In v2.1.0, Django 3.2 support was removed. Ensure your project uses Django 4.0+.","severity":"breaking","affected_versions":"2.1.0+"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run: pip install openedx-django-wiki and then import wiki in your code.","cause":"You installed the wrong package or the package is not installed. The module is 'wiki', not 'openedx_django_wiki'.","error":"ModuleNotFoundError: No module named 'wiki'"},{"fix":"Uninstall both and reinstall only openedx-django-wiki. Ensure only one wiki app is in INSTALLED_APPS.","cause":"You have both 'django-wiki' and 'openedx-django-wiki' installed, or you have conflicting apps in INSTALLED_APPS.","error":"django.core.exceptions.ImproperlyConfigured: Application labels aren't unique, duplicates: wiki"},{"fix":"Use: from wiki.urls import get_pattern. Then call get_pattern().","cause":"Incorrect import path. The get_pattern function is in wiki.urls.","error":"AttributeError: module 'wiki' has no attribute 'get_pattern'"},{"fix":"Change import to: from wiki.decorators import WikiDecoratorMixin","cause":"The module location changed in v2.0.0.","error":"ImportError: cannot import name 'WikiDecoratorMixin' from 'wiki.core.decorators'"},{"fix":"Add 'mptt', 'sekizai', 'django_nyt' to INSTALLED_APPS.","cause":"Missing required Django apps: mptt, sekizai, django_nyt.","error":"django.core.management.base.SystemCheckError: SystemCheckError: Issue with 'wiki' models [...]"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}