{"id":16843363,"url":"https://github.com/barttc/django-wakawaka","last_synced_at":"2025-05-16T11:03:52.125Z","repository":{"id":578963,"uuid":"211765","full_name":"bartTC/django-wakawaka","owner":"bartTC","description":"A simple wiki app written in Python using the Django framework.","archived":false,"fork":false,"pushed_at":"2024-11-19T08:45:07.000Z","size":464,"stargazers_count":118,"open_issues_count":0,"forks_count":53,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-16T11:03:51.635Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bartTC.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2009-05-27T18:34:37.000Z","updated_at":"2025-04-07T23:52:55.000Z","dependencies_parsed_at":"2024-06-20T23:25:51.510Z","dependency_job_id":"edc272b8-ded3-4d85-b6ac-15100c58a382","html_url":"https://github.com/bartTC/django-wakawaka","commit_stats":{"total_commits":110,"total_committers":12,"mean_commits":9.166666666666666,"dds":"0.23636363636363633","last_synced_commit":"0ea998e1571c47682300bb4a26f80c362dee4ff0"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bartTC%2Fdjango-wakawaka","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bartTC%2Fdjango-wakawaka/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bartTC%2Fdjango-wakawaka/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bartTC%2Fdjango-wakawaka/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bartTC","download_url":"https://codeload.github.com/bartTC/django-wakawaka/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254518384,"owners_count":22084374,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-13T12:50:39.737Z","updated_at":"2025-05-16T11:03:52.106Z","avatar_url":"https://github.com/bartTC.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![](https://badge.fury.io/py/django-wakawaka.svg)](https://badge.fury.io/py/django-wakawaka)\n\n_Compatibility Matrix:_\n\n| Py/Dj     | 3.9 | 3.10 | 3.11 | 3.12 | 3.13 |\n| --------- | --- | ---- | ---- | ---- |------|\n| 4.2 (LTS) | ✓   | ✓    | ✓    | ✓    | ✓    |\n| 5.0       |     | ✓    | ✓    | ✓    | ✓    |\n| 5.1       |     | ✓    | ✓    | ✓    | ✓    |\n\n# django-wakawaka\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][WikiIndex Page]\n- [Revision List][Revision List]\n- [Page History][Page History]\n- [Page List][Page List]\n\n[WikiIndex Page]: https://github.com/bartTC/django-wakawaka/raw/main/docs/_static/overview.png\n[Revision List]: https://github.com/bartTC/django-wakawaka/raw/main/docs/_static/revisions.png\n[Page History]: https://github.com/bartTC/django-wakawaka/raw/main/docs/_static/history.png\n[Page List]: https://github.com/bartTC/django-wakawaka/raw/main/docs/_static/pagelist.png\n\n## Installation:\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## Configuration:\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\n### Optional Settings:\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### Attachments:\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][django-attachments]\nwhich provides a unobstrusive way to add attachments to models.\n\n## Testing and Development:\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 [Poetry][poetry]:\n\n    $ poetry install\n    $ pipenv run pytest\n\n## Example Project:\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    $ poetry install\n    $ poetry run ./manage.py migrate\n    $ poetry run ./manage.py createsuperuser\n    $ poetry run ./manage.py runserver\n\n[django-attachments]: https://github.com/bartTC/django-attachments\n[poetry]: https://python-poetry.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarttc%2Fdjango-wakawaka","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbarttc%2Fdjango-wakawaka","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarttc%2Fdjango-wakawaka/lists"}