一个简单的基于Django的wiki系统。
项目描述
兼容性矩阵
Py/Dj | 3.8 | 3.9 | 3.10 | 3.11 | 3.12 |
---|---|---|---|---|---|
3.2 (LTS) | ✓ | ✓ | ✓ | ✓ | ✓ |
4.0 | ✓ | ✓ | ✓ | ✓ | ✓ |
4.1 | ✓ | ✓ | ✓ | ✓ | ✓ |
4.2 (LTS) | ✓ | ✓ | ✓ | ✓ | ✓ |
5.0 | ✓ | ✓ | ✓ |
django-wakawaka
django-wakawaka是一个使用Python和Django框架编写的非常简单的wiki系统。
-
Wiki页面之间的链接将通过其驼峰命名方案自动解析。
-
它自动跟踪页面修订的变化,同时提供回滚到早期状态的能力。
-
它还具有相当全面的权限集成,负责处理Django的默认创建/编辑/删除权限。
-
Wakawaka是一个应用程序,旨在放置在现有项目中。
来自《示例项目》的一些截图
安装
- 将
wakawaka
添加到您的django项目的settings.py中的INSTALLED_APPS。 - 将
(r'^wiki/', include('wakawaka.urls')),
添加到您的urls.py。
这就完成了。Wakawaka除了Django 1.11或更高版本外没有其他依赖项。
配置
Wakawaka负责Django的权限系统。授予您的用户始终有一对 wikipage
和 revision
权限,以便他们可以进行操作。(添加、更改或删除Wiki页面)
可选设置
您的第一个维基页面的名称定义为 WikiIndex
。您可以通过在settings.py中添加设置 WAKAWAKA_DEFAULT_INDEX
来更改此名称。示例
WAKAWAKA_DEFAULT_INDEX = 'Home'
使用驼峰命名法(一个首字母大写后跟 n 个小写字母)编写的单词将被自动处理为内部维基链接。您可以通过在settings.py中添加设置 WAKAWAKA_SLUG_REGEX
来更改此行为。这包含维基名称格式的正则表达式。默认
WAKAWAKA_SLUG_REGEX = r'((([A-Z]+[a-z]+){2,})(/([A-Z]+[a-z]+){2,})*)'
附件
Wakawaka 不提供将文件附件存储到维基页面上的功能。要实现此功能,请查看侧项目 django-attachments,该项目提供了一种无干扰的方式来向模型添加附件。
测试和开发
该项目附带了一个测试库,可以通过Tox简单地调用,该库在所有当前Python和Django版本下测试该项目
$ pip install tox
$ tox
要在您的开发环境中手动运行测试套件,请使用 Poetry 安装项目
$ poetry install
$ pipenv run pytest
示例项目
应用程序附带一个示例项目。这为您提供了对Wiki功能的简要概述,并有助于将应用程序集成到现有项目中。它还用于测试套件
$ poetry install
$ poetry run ./manage.py migrate
$ poetry run ./manage.py createsuperuser
$ poetry run ./manage.py runserver
变更日志
v1.5 (2024-07-10)
- 从pipenv切换到Poetry构建系统
- IP地址字段现在是可选的
v1.4 (2023-12-15)
- 添加了对Django 5.0的支持。
- 添加了对Python 3.12的支持
- 类型注解
v1.3 (2022-04-30)
- 添加了对Django 3.2到4.2的支持。
- 添加了对Python 3.8到3.11的支持。
v1.2 (2020-01-08)
- 放弃了对Python 2.7的支持。
- 添加了对Python 3.8的支持。
- 添加了对Django 2.2和3.0的支持。
v1.1 (2019-01-21)
- 与Django 2.1兼容并进一步清理。
- 放弃了对Django <v1.11的支持。
- 放弃了对“认证”URL模式的支持,这些模式已经一段时间没有功能了。
v1.0 (2016-11-26)
- 与Django 1.10兼容并进行全面清理。
- 完全兼容Python 3。
- 删除了对Pinax Group的支持。
- 测试。
v0.3: (2009-08-06)
- 如果找不到维基页面,现在视图将引发一个适当的Http404,而不是(静默的)HttpResponseNotFound。这使您能够显示一个适当的404页面。
- 现在所有模板都使用gettext进行可翻译性。
v0.2 (2009-07-22)
- 编辑表单现在是可替换的
项目详情
下载文件
下载适用于您的平台文件。如果您不确定选择哪个,请了解更多关于 安装软件包 的信息。