.. image:: https://badge.fury.io/py/django-wakawaka.svg
:target: https://badge.fury.io/py/django-wakawaka
*Compatibility Matrix:*
========= === === ==== ==== ====
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 is a super simple wiki system written in Python using the
Django framework.
* Links between Wiki pages are automatically resolved by their CamelCase naming
scheme.
* It automatically keeps track of revision changes of a Page, while
providing the ability to revert to earlier states.
* It also has a quite comprehensive permission integration, taking care of
Django's default create/edit/delete permissions.
* Wakawaka is an application and indented to be placed in an existing project.
Some screenshots from the *Example Project*:
* `WikiIndex Page`_
* `Revision List`_
* `Page History`_
* `Page List`_
.. _WikiIndex Page: https://github.com/bartTC/django-wakawaka/raw/master/docs/_static/overview.png
.. _Revision List: https://github.com/bartTC/django-wakawaka/raw/master/docs/_static/revisions.png
.. _Page History: https://github.com/bartTC/django-wakawaka/raw/master/docs/_static/history.png
.. _Page List: https://github.com/bartTC/django-wakawaka/raw/master/docs/_static/pagelist.png
Installation:
=============
1. Put ``wakawaka`` to your INSTALLED_APPS in your settings.py within your
django project.
2. Add ``(r'^wiki/', include('wakawaka.urls')),`` to your urls.py.
That's all. Wakawaka has no other dependencies than Django 1.11 or later.
Configuration:
==============
Wakawaka takes care of Django's permission system. Grant your users always a
pair of ``wikipage`` and ``revision`` permissions either what they should do.
(Adding, changing or deleting WikiPages)
Optional Settings:
------------------
The name of your first wiki page is defined as ``WikiIndex``. You can change
this by adding a setting ``WAKAWAKA_DEFAULT_INDEX`` to your settings.py.
Example::
WAKAWAKA_DEFAULT_INDEX = 'Home'
Words that are written in CamelCase (a pair of one upper letter followed by
*n* lower letters) are automatically treated as internal wiki links. You can
change this behaviour by adding a setting ``WAKAWAKA_SLUG_REGEX`` to your
settings.py. This holds a regular expression of the wiki name format. Default::
WAKAWAKA_SLUG_REGEX = r'((([A-Z]+[a-z]+){2,})(/([A-Z]+[a-z]+){2,})*)'
Attachments:
============
Wakawaka does not provide the ability to store file attachments to wiki pages.
To do so, have a look on the side project `django-attachments`_ which provides
a unobstrusive way to add attachments to models.
Testing and Development:
========================
The project comes with a test library which can be simply invoked by Tox,
which tests the project under all current Python and Django versions::
$ pip install tox
$ tox
To run the testsuite manually in your development environment, install the
project using pipenv_::
$ pipenv install
$ pipenv run tests
Example Project:
================
The application comes with a sample project. This gives you a brief overview
about the Wiki features, and can help you with the integration of the
application into an existing project. It's alo used for the test suite::
$ pipenv install
$ pipenv run ./manage.py migrate
$ pipenv run ./manage.py createsuperuser
$ pipenv run ./manage.py runserver
.. _django-attachments: https://github.com/bartTC/django-attachments
.. _pipenv: https://pipenv.readthedocs.io/
==========
Changelog:
==========
v1.4 (2023-12-15):
- Added support for Django 5.0.
- Added support for Python 3.12
- Type Annotations
v1.3 (2022-04-30):
- Added support for Django 3.2 to 4.2.
- Added support for Python 3.8 to 3.11.
v1.2 (2020-01-08):
- Dropped support for Python 2.7.
- Added support for Python 3.8.
- Added support for Django 2.2 and 3.0.
v1.1 (2019-01-21):
- Django 2.1 compatibility and and further cleanup.
- Dropped support for Django <v1.11.
- Dropped "authenticated" url patterns which were not functional since a while.
v1.0 (2016-11-26):
- Django 1.10 compatibility and total cleanup.
- Full Python 3 compatibility.
- Removed Pinax Group support.
- Tests.
v0.3: (2009-08-06):
- If a wikipage was not found, the view now raises a proper Http404 instead of
a (silent) HttpResponseNotFound. This gives you the ability to display a
proper 404 page.
- All templates are now translatable using gettext.
v0.2 (2009-07-22):
- Edit-forms are now replaceable
Raw data
{
"_id": null,
"home_page": "https://github.com/bartTC/django-wakawaka",
"name": "django-wakawaka",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "django,wiki,wikipedia,documentation",
"author": "Martin Mahner",
"author_email": "martin@mahner.org",
"download_url": "https://files.pythonhosted.org/packages/10/4f/0868df08a51c771d8e625b35615d88a82a04e35387075c196b0f62f78324/django-wakawaka-1.4.tar.gz",
"platform": null,
"description": ".. image:: https://badge.fury.io/py/django-wakawaka.svg\n :target: https://badge.fury.io/py/django-wakawaka\n\n*Compatibility Matrix:*\n\n========= === === ==== ==== ====\nPy/Dj 3.8 3.9 3.10 3.11 3.12\n========= === === ==== ==== ====\n3.2 (LTS) \u2713 \u2713 \u2713 \u2713 \u2713\n4.0 \u2713 \u2713 \u2713 \u2713 \u2713\n4.1 \u2713 \u2713 \u2713 \u2713 \u2713\n4.2 (LTS) \u2713 \u2713 \u2713 \u2713 \u2713\n5.0 \u2713 \u2713 \u2713\n========= === === ==== ==== ====\n\n===============\ndjango-wakawaka\n===============\n\ndjango-wakawaka is a super simple wiki system written in Python using the\nDjango framework.\n\n* Links between Wiki pages are automatically resolved by their CamelCase naming\n scheme.\n\n* It automatically keeps track of revision changes of a Page, while\n providing the ability to revert to earlier states.\n\n* It also has a quite comprehensive permission integration, taking care of\n Django's default create/edit/delete permissions.\n\n* Wakawaka is an application and indented to be placed in an existing project.\n\nSome screenshots from the *Example Project*:\n\n* `WikiIndex Page`_\n* `Revision List`_\n* `Page History`_\n* `Page List`_\n\n.. _WikiIndex Page: https://github.com/bartTC/django-wakawaka/raw/master/docs/_static/overview.png\n.. _Revision List: https://github.com/bartTC/django-wakawaka/raw/master/docs/_static/revisions.png\n.. _Page History: https://github.com/bartTC/django-wakawaka/raw/master/docs/_static/history.png\n.. _Page List: https://github.com/bartTC/django-wakawaka/raw/master/docs/_static/pagelist.png\n\n\nInstallation:\n=============\n\n1. Put ``wakawaka`` to your INSTALLED_APPS in your settings.py within your\n django project.\n2. Add ``(r'^wiki/', include('wakawaka.urls')),`` to your urls.py.\n\nThat's all. Wakawaka has no other dependencies than Django 1.11 or later.\n\n\nConfiguration:\n==============\n\nWakawaka takes care of Django's permission system. Grant your users always a\npair of ``wikipage`` and ``revision`` permissions either what they should do.\n(Adding, changing or deleting WikiPages)\n\nOptional Settings:\n------------------\n\nThe name of your first wiki page is defined as ``WikiIndex``. You can change\nthis by adding a setting ``WAKAWAKA_DEFAULT_INDEX`` to your settings.py.\nExample::\n\n WAKAWAKA_DEFAULT_INDEX = 'Home'\n\nWords that are written in CamelCase (a pair of one upper letter followed by\n*n* lower letters) are automatically treated as internal wiki links. You can\nchange this behaviour by adding a setting ``WAKAWAKA_SLUG_REGEX`` to your\nsettings.py. This holds a regular expression of the wiki name format. Default::\n\n WAKAWAKA_SLUG_REGEX = r'((([A-Z]+[a-z]+){2,})(/([A-Z]+[a-z]+){2,})*)'\n\n\nAttachments:\n============\n\nWakawaka does not provide the ability to store file attachments to wiki pages.\nTo do so, have a look on the side project `django-attachments`_ which provides\na unobstrusive way to add attachments to models.\n\n\nTesting and Development:\n========================\n\nThe project comes with a test library which can be simply invoked by Tox,\nwhich tests the project under all current Python and Django versions::\n\n $ pip install tox\n $ tox\n\nTo run the testsuite manually in your development environment, install the\nproject using pipenv_::\n\n $ pipenv install\n $ pipenv run tests\n\n\nExample Project:\n================\n\nThe application comes with a sample project. This gives you a brief overview\nabout the Wiki features, and can help you with the integration of the\napplication into an existing project. It's alo used for the test suite::\n\n $ pipenv install\n $ pipenv run ./manage.py migrate\n $ pipenv run ./manage.py createsuperuser\n $ pipenv run ./manage.py runserver\n\n.. _django-attachments: https://github.com/bartTC/django-attachments\n.. _pipenv: https://pipenv.readthedocs.io/\n\n==========\nChangelog:\n==========\n\nv1.4 (2023-12-15):\n\n- Added support for Django 5.0.\n- Added support for Python 3.12\n- Type Annotations\n\nv1.3 (2022-04-30):\n\n- Added support for Django 3.2 to 4.2.\n- Added support for Python 3.8 to 3.11.\n\nv1.2 (2020-01-08):\n\n- Dropped support for Python 2.7.\n- Added support for Python 3.8.\n- Added support for Django 2.2 and 3.0.\n\nv1.1 (2019-01-21):\n\n- Django 2.1 compatibility and and further cleanup.\n- Dropped support for Django <v1.11.\n- Dropped \"authenticated\" url patterns which were not functional since a while.\n\nv1.0 (2016-11-26):\n\n- Django 1.10 compatibility and total cleanup.\n- Full Python 3 compatibility.\n- Removed Pinax Group support.\n- Tests.\n\nv0.3: (2009-08-06):\n\n- If a wikipage was not found, the view now raises a proper Http404 instead of\n a (silent) HttpResponseNotFound. This gives you the ability to display a\n proper 404 page.\n- All templates are now translatable using gettext.\n\nv0.2 (2009-07-22):\n\n- Edit-forms are now replaceable\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple Django based wiki system.",
"version": "1.4",
"project_urls": {
"Homepage": "https://github.com/bartTC/django-wakawaka"
},
"split_keywords": [
"django",
"wiki",
"wikipedia",
"documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8f9f8281fddbe467f3b795cb10fc229a7c2e07751dc09c375e31b1adcbeed585",
"md5": "b4c0e36f2e3ae774e7e6b33c83a49e88",
"sha256": "d27bb8d1a8a591cfbde2fab129faf1f4d77ea3e1bde4d3a745729d68d5a0c358"
},
"downloads": -1,
"filename": "django_wakawaka-1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4c0e36f2e3ae774e7e6b33c83a49e88",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 33554,
"upload_time": "2023-12-15T06:19:32",
"upload_time_iso_8601": "2023-12-15T06:19:32.191230Z",
"url": "https://files.pythonhosted.org/packages/8f/9f/8281fddbe467f3b795cb10fc229a7c2e07751dc09c375e31b1adcbeed585/django_wakawaka-1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "104f0868df08a51c771d8e625b35615d88a82a04e35387075c196b0f62f78324",
"md5": "d1b8e5beee0b20c49ea3a6f150ffda4d",
"sha256": "2094ad0e578b733568609d977085907e64bcbfc0ab37af8d746d8593b554909b"
},
"downloads": -1,
"filename": "django-wakawaka-1.4.tar.gz",
"has_sig": false,
"md5_digest": "d1b8e5beee0b20c49ea3a6f150ffda4d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 313844,
"upload_time": "2023-12-15T06:19:34",
"upload_time_iso_8601": "2023-12-15T06:19:34.540334Z",
"url": "https://files.pythonhosted.org/packages/10/4f/0868df08a51c771d8e625b35615d88a82a04e35387075c196b0f62f78324/django-wakawaka-1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-15 06:19:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bartTC",
"github_project": "django-wakawaka",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "django-wakawaka"
}
JSON
