Skip to content

pinax/pinax-forums

Repository files navigation

Pinax Forums

CircleCi Codecov

Table of Contents

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.

Important Links

Where you can find what you need:

pinax-forums

Overview

pinax-forums is an extensible forums app for Django and Pinax. It is focused on core forum functionality and hence is expected to be combined with other Pinax apps for broader features.

Supported Django and Python Versions

Django / Python 3.6 3.7 3.8
2.2 * * *
3.0 * * *

Documentation

Installation

To install pinax-forums:

$ pip install pinax-forums

Add pinax.forums to your INSTALLED_APPS setting:

INSTALLED_APPS = [
    # other apps
    "pinax.forums",
]

Add pinax.forums.urls to your project urlpatterns:

urlpatterns = [
    # other urls
    url(r"^forums/", include("pinax.forums.urls", namespace="pinax_forums")),
]

Settings

PINAX_FORUMS_EDIT_TIMEOUT

Allow changes for up to PINAX_FORUMS_EDIT_TIMEOUT seconds after creating a post. Once this period has expired the post is no longer editable.

PINAX_FORUMS_HOOKSET

Templates

The templates referenced by pinax-forums code must be supplied by the user. Place template files in a pinax/forums/ subfolder in your project template search path.

category.html

forum.html

forums.html

post_create.html

post_edit.html

reply_create.html

subscribe.html

thread.html

thread_updates.html

unsubscribe.html

Change Log

2.0.0

  • Drop Django 1.11, 2.0, and 2.1, and Python 2,7, 3.4, and 3.5 support
  • Add Django 2.2 and 3.0, and Python 3.6, 3.7, and 3.8 support
  • Update packaging configs
  • Direct users to community resources

1.0.2

  • Allow use with any account-management package by removing django-user-accounts dependency

1.0.1

  • Add django>=1.11 to installation requirements
  • Update CI configuration
  • Delete unused files
  • Update documentation
  • Fix license target link

1.0.0

  • Add Django 2.0 compatibility testing
  • Drop Django 1.8, 1.9, 1.10, and Python 3.3 support
  • Move documentation into README and standardize layout
  • Convert CI and coverage to CircleCi and CodeCov
  • Add PyPi-compatible long description

History

pinax-forums was originally built by Eldarion and called agora. It incorporates code and ideas from various client projects. The clients were kind enough to allow Eldarion to open source the app and contribute it to Pinax.

Contribute

Contributing information can be found in the Pinax community health file repo.

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-present James Tauber and contributors under the MIT license.