pinax / pinax-wiki

Easily add a wiki to your Django site

Pinax

Table of Contents

• About Pinax
• Overview
  • Dependencies
  • Supported Django and Python versions
• Documentation
  • Installation
  • Usage
• Change Log
• Contribute
• Code of Conduct
• Connect with Pinax
• License

About Pinax

Pinax is an open-source platform built on the Django Web Framework. It is an ecosystem of reusable Django apps, themes, and starter project templates. This collection can be found at http://pinaxproject.com.

Overview

This repository contains documentation for the Pinax project.

Documentation

Updating Online Documentation

The docs live online at http://pinaxproject.com/pinax/.

After a pull request is merged, checkout your local master branch:

git checkout master

Pull the update into your local master branch:

git pull origin master

Push the update live to gh-pages:

mkdocs gh-deploy

Publishing a Distribution

projects.json

distribution.json

Change Log

Contribute

For an overview on how contributing to Pinax works read this blog post and watch the included video, or read our How to Contribute section. For concrete contribution ideas, please see our Ways to Contribute/What We Need Help With section.

In case of any questions we recommend you join our Pinax Slack team and ping us there instead of creating an issue on GitHub. Creating issues on GitHub is of course also valid but we are usually able to help you faster if you ping us in Slack.

We also highly recommend reading our blog post on Open Source and Self-Care.

Code of Conduct

In order to foster a kind, inclusive, and harassment-free community, the Pinax Project has a code of conduct. We ask you to treat everyone as a smart human programmer that shares an interest in Python, Django, and Pinax with you.

Connect with Pinax

For updates and news regarding the Pinax Project, please follow us on Twitter @pinaxproject and check out our Pinax Project blog.

License

Copyright (c) 2012-2018 James Tauber and contributors under the MIT license.

pinax-wiki's Issues

Setup instructions spotty

I was trying to find out how to set up the wiki correctly but the instructions are not complete.

I saw that I need to add "wiki" to INSTALLED_APPS (shouldn't it be "pinax.wiki" for consistency?) and then I was trying to figure what I have to add to urls.py. From url(r"^blog/", include("pinax.blog.urls")) I abstracted that it must be url(r"^blog/", include("pinax.wiki.urls")) which is what I added.

Then I ran python manage.py migrate, python manage.py loaddata sites and python manage.py runserver.

Unfortunately it breaks with ImportError at /admin/ No module named wiki.urls" so I just stopped there. Also running the server throws "WARNINGS: wiki.Revision.created_ip: (fields.W900) IPAddressField has been deprecated. Support for it (except in historical migrations) will be removed in Django 1.9. HINT: Use GenericIPAddressField instead.

Creole requirement fails when using Python 3

Creole creates an error when running step:

pip install -r requirements.txt

Error in terminal when using python 3.4.3 in virtualenv:

Collecting creole
  Using cached creole-1.2.tar.gz
    Complete output from command python setup.py egg_info:
    Traceback (most recent call last):
      File "<string>", line 20, in <module>
      File "/private/var/folders/77/9fknv29s0gl41xyznf7mrs3m0000gp/T/pip-build-e8cn8h21/creole/setup.py", line 4, in <module>
        import creole
      File "/private/var/folders/77/9fknv29s0gl41xyznf7mrs3m0000gp/T/pip-build-e8cn8h21/creole/creole/__init__.py", line 28, in <module>
        from creole.rules import Rules

    ----------------------------------------
    Command "python setup.py egg_info" failed with error code 1 in /private/var/folders/77/9fknv29s0gl41xyznf7mrs3m0000gp/T/pip-build-e8cn8h21/creole

Attempting pip install creole fails as well leading me to believe this is an error with the creole library's pypy listing - but this is conjecture at this time.

Telling virtualenv to use python 2 explicitly using virtualenv -p /usr/bin/python pinaxwikienv (on mac os x) resolves the issue and the project works as expected.

Add signals for all activity

Add the ability to list and view revisions

What should the Django Admin look like for this app?

Replace IPAddressField with GenericIPAddressField

wiki.Revision.created_ip: (fields.W900) IPAddressField has been deprecated. Support for it (except in historical migrations) will be removed in Django 1.9.
HINT: Use GenericIPAddressField instead.

Namespace under a `pinax.wiki` package

Relation to user should use settings.AUTH_USER_MODEL

Relation to user models should use settings.AUTH_USER_MODEL instead of directly referencing the User model.

It generate two errors when making migrations:

ERRORS:
pinax_wiki.MediaFile.user: (fields.E301) Field defines a relation with the model 'auth.User', which has been swapped out.
HINT: Update the relation to point at 'settings.AUTH_USER_MODEL'.
pinax_wiki.Revision.created_by: (fields.E301) Field defines a relation with the model 'auth.User', which has been swapped out.
HINT: Update the relation to point at 'settings.AUTH_USER_MODEL'.

Add ability to delete a page

Add support for WikiWords

Upgrading to the Py3 compatible creole library meant losing WikiWord support. Add it back.

Update CONTRIBUTING.md File

needs patch

pinax-wiki wants a patch @paltman! 😄

Write Test Suite

I realize this is an on going task but let's use this Issue to just get one started with some decent headway on code coverage.

We can close this issue when test coverage is > 75%

Add permission hook for checking the ability to upload to the wiki

Call for Maintainers

Looking for maintainers!

There is a lot of pull requests and open issues that the current maintainers, myself included, are just not finding the time to properly get to.

Maybe you've submitted some PRs and are frustrated with the lack of attention. Maybe you use this project in one or more of your projects and want to see that it is properly carried forward.

Whatever you reasons may be, let me know if you have interest and I'll add you to the repo and to PyPI (will need your PyPI name).

Preference will go to those who have commits on this repo and/or have shown an active interest in the issues.

Thanks!
Patrick

ImproperlyConfigured bug

I've install the project-wiki, and got the ImproperlyConfigured bug

This error is from

url(os.path.join(binder.root, r"(?P<slug>[^/]+)/edit/$"), "edit", {"binder": binder}, name=binder.edit_url_name),

line from c:\Python27\Lib\site-packages\wiki\urls.py file

Python 2.7.8, django 1.6.5

Improperly configured regex in pinax.wiki.urls?

django.core.exceptions.ImproperlyConfigured: "^wiki\(?P<slug>[^/]+)/$" is not a valid regular expression: unbalanced parenthesis at position 20

Not sure why it's getting the error, because I'm not smart enough.

Installed exactly as instructed; Am I doing something wrong?

error in utils.py

File "/home/XXX/lib/python2.6/site-packages/wiki/utils.py", line 7
for x in settings.WIKI_BINDERS
^
SyntaxError: invalid syntax

Full code from utils.py:

from .conf import settings

def binders_map():
return {
x.bind_to_model_name: x
for x in settings.WIKI_BINDERS
}

def object_slug(wiki):
if wiki:
slug = wiki.content_type.model
else:
slug = "default"
return slug

Add ability to see all media you have uploaded and where it's in use

Replace MediaFile with pinax-images

To be consistent with pinax/pinax-blog#73

Missing setup.cfg

Should that exist?

Write Documentation

Create a rich frontend editing experience

To be consistent with pinax/pinax-blog#62