Dropping support and updating docs

pinax · Jan 4, 2018 · bb2b2c6 · bb2b2c6
1 parent a260393
commit bb2b2c6
Show file tree

Hide file tree

Showing 4 changed files with 117 additions and 65 deletions.
diff --git a/README.md b/README.md
@@ -1,28 +1,62 @@
+![](http://pinaxproject.com/pinax-design/patches/pinax-forums.svg)
+
 # Pinax Forums
 
-[![](http://slack.pinaxproject.com/badge.svg)](http://slack.pinaxproject.com/)
-[![](https://img.shields.io/travis/pinax/pinax-forums.svg)](https://travis-ci.org/pinax/pinax-forums)
-[![](https://img.shields.io/coveralls/pinax/pinax-forums.svg)](https://coveralls.io/r/pinax/pinax-forums)
-[![](https://img.shields.io/pypi/dm/pinax-forums.svg)](https://pypi.python.org/pypi/pinax-forums/)
 [![](https://img.shields.io/pypi/v/pinax-forums.svg)](https://pypi.python.org/pypi/pinax-forums/)
-[![](https://img.shields.io/badge/license-MIT-blue.svg)](https://pypi.python.org/pypi/pinax-forums/)
 
-## Pinax
+[![CircleCi](https://img.shields.io/circleci/project/github/pinax/pinax-forums.svg)](https://circleci.com/gh/pinax/pinax-forums)
+[![Codecov](https://img.shields.io/codecov/c/github/pinax/pinax-forums.svg)](https://codecov.io/gh/pinax/pinax-forums)
+[![](https://img.shields.io/github/contributors/pinax/pinax-forums.svg)](https://github.com/pinax/pinax-forums/graphs/contributors)
+[![](https://img.shields.io/github/issues-pr/pinax/pinax-forums.svg)](https://github.com/pinax/pinax-forums/pulls)
+[![](https://img.shields.io/github/issues-pr-closed/pinax/pinax-forums.svg)](https://github.com/pinax/pinax-forums/pulls?q=is%3Apr+is%3Aclosed)
+
+[![](http://slack.pinaxproject.com/badge.svg)](http://slack.pinaxproject.com/)
+[![](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
 
-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.
+## Table of Contents
 
-This app was developed as part of the Pinax ecosystem but is just a Django app
-and can be used independently of other Pinax apps.
+* [About Pinax](#about-pinax)
+* [Overview](#overview)
+  * [Supported Django and Python versions](#supported-django-and-python-versions)
+* [Change Log](#change-log)
+* [History](#history)
+* [Contribute](#contribute)
+* [Code of Conduct](#code-of-conduct)
+* [Connect with Pinax](#connect-with-pinax)
+* [License](#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.
 
 ## 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 | 2.7 | 3.4 | 3.5 | 3.6
+--------------- | --- | --- | --- | ---
+1.11 |  *  |  *  |  *  |  *  
+2.0  |     |  *  |  *  |  *
+
+
+## Change Log
+
+### 
+
+* 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
 
@@ -32,27 +66,33 @@ The clients were kind enough to allow Eldarion to open source the app and
 contribute it to Pinax.
 
 
-## Documentation
+## Contribute
 
-The `pinax-forums` documentation is currently under construction. If you would
-like to help us write documentation, please join our Pinax Project Slack team
-and let us know! The Pinax documentation is available at http://pinaxproject.com/pinax/.
+For an overview on how contributing to Pinax works read this [blog post](http://blog.pinaxproject.com/2016/02/26/recap-february-pinax-hangout/)
+and watch the included video, or read our [How to Contribute](http://pinaxproject.com/pinax/how_to_contribute/) section.
+For concrete contribution ideas, please see our
+[Ways to Contribute/What We Need Help With](http://pinaxproject.com/pinax/ways_to_contribute/) section.
 
+In case of any questions we recommend you join our [Pinax Slack team](http://slack.pinaxproject.com)
+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.
 
-## Contribute
+We also highly recommend reading our blog post on [Open Source and Self-Care](http://blog.pinaxproject.com/2016/01/19/open-source-and-self-care/).
 
-See [this blog post](http://blog.pinaxproject.com/2016/02/26/recap-february-pinax-hangout/) including a video, or our [How to Contribute](http://pinaxproject.com/pinax/how_to_contribute/) section for an overview on how contributing to Pinax works. For concrete contribution ideas, please see our [Ways to Contribute/What We Need Help With](http://pinaxproject.com/pinax/ways_to_contribute/) section.
 
-In case of any questions we recommend you [join our Pinax Slack team](http://slack.pinaxproject.com) 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.
+## Code of Conduct
 
-We also highly recommend reading our [Open Source and Self-Care blog post](http://blog.pinaxproject.com/2016/01/19/open-source-and-self-care/).  
+In order to foster a kind, inclusive, and harassment-free community, the Pinax Project
+has a [code of conduct](http://pinaxproject.com/pinax/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.
 
 
-## Code of Conduct
+## Connect with Pinax
 
-In order to foster a kind, inclusive, and harassment-free community, the Pinax Project has a code of conduct, which can be found [here](http://pinaxproject.com/pinax/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.
+For updates and news regarding the Pinax Project, please follow us on Twitter [@pinaxproject](https://twitter.com/pinaxproject)
+and check out our [Pinax Project blog](http://blog.pinaxproject.com).
 
 
-## Pinax Project Blog and Twitter
+## License
 
-For updates and news regarding the Pinax Project, please follow us on Twitter at @pinaxproject and check out our [blog]( http://blog.pinaxproject.com).
+Copyright (c) 2012-2018 James Tauber and contributors under the [MIT license](https://opensource.org/licenses/MIT).
diff --git a/pinax/forums/models.py b/pinax/forums/models.py
@@ -23,7 +23,7 @@ def issue_update(kind, **kwargs):
 class ForumCategory(models.Model):
 
     title = models.CharField(max_length=100)
-    parent = models.ForeignKey("self", null=True, blank=True, related_name="subcategories")
+    parent = models.ForeignKey("self", null=True, blank=True, related_name="subcategories", on_delete=models.CASCADE)
 
     # @@@ total descendant forum count?
     # @@@ make group-aware
@@ -54,7 +54,8 @@ class Forum(models.Model):
         "self",
         null=True,
         blank=True,
-        related_name="subforums"
+        related_name="subforums",
+        on_delete=models.CASCADE
     )
     category = models.ForeignKey(
         ForumCategory,
@@ -238,7 +239,7 @@ def restore(cls, in_):
 
 class ForumPost(models.Model):
 
-    author = models.ForeignKey(settings.AUTH_USER_MODEL, related_name="%(app_label)s_%(class)s_related")
+    author = models.ForeignKey(settings.AUTH_USER_MODEL, related_name="%(app_label)s_%(class)s_related", on_delete=models.CASCADE)
     content = models.TextField()
     content_html = models.TextField()
     created = models.DateTimeField(default=timezone.now, editable=False)
@@ -264,7 +265,7 @@ class ForumThread(ForumPost):
     # used for code that needs to know the kind of post this object is.
     kind = "thread"
 
-    forum = models.ForeignKey(Forum, related_name="threads")
+    forum = models.ForeignKey(Forum, related_name="threads", on_delete=models.CASCADE)
     title = models.CharField(max_length=100)
     last_modified = models.DateTimeField(
         default=timezone.now,
@@ -355,7 +356,7 @@ class ForumReply(ForumPost):
     # used for code that needs to know the kind of post this object is.
     kind = "reply"
 
-    thread = models.ForeignKey(ForumThread, related_name="replies")
+    thread = models.ForeignKey(ForumThread, related_name="replies", on_delete=models.CASCADE)
 
     class Meta:
         verbose_name = "forum reply"
@@ -364,7 +365,7 @@ class Meta:
 
 class UserPostCount(models.Model):
 
-    user = models.ForeignKey(settings.AUTH_USER_MODEL, related_name="post_count")
+    user = models.ForeignKey(settings.AUTH_USER_MODEL, related_name="post_count", on_delete=models.CASCADE)
     count = models.IntegerField(default=0)
 
     @classmethod
@@ -387,8 +388,8 @@ def calculate(cls):
 
 class ThreadSubscription(models.Model):
 
-    thread = models.ForeignKey(ForumThread, related_name="subscriptions")
-    user = models.ForeignKey(settings.AUTH_USER_MODEL, related_name="forum_subscriptions")
+    thread = models.ForeignKey(ForumThread, related_name="subscriptions", on_delete=models.CASCADE)
+    user = models.ForeignKey(settings.AUTH_USER_MODEL, related_name="forum_subscriptions", on_delete=models.CASCADE)
     kind = models.CharField(max_length=15)
 
     class Meta:

diff --git a/pinax/forums/urls.py b/pinax/forums/urls.py
@@ -13,6 +13,8 @@
     unsubscribe,
 )
 
+app_name = "pinax_forums"
+
 # Expected that these are mounted under namespace "pinax_forums"
 urlpatterns = [
     url(r"^$", forums, name="forums"),

diff --git a/setup.py b/setup.py
@@ -1,71 +1,80 @@
 from setuptools import find_packages, setup
 
-
+VERSION = "1.0.0"
 LONG_DESCRIPTION = """
+.. image:: http://pinaxproject.com/pinax-design/patches/pinax-forums.svg
+    :target: https://pypi.python.org/pypi/pinax-forums/
+
 ============
 Pinax Forums
 ============
-.. image:: http://slack.pinaxproject.com/badge.svg
-   :target: http://slack.pinaxproject.com/
-
-.. image:: https://img.shields.io/travis/pinax/pinax-forums.svg
-    :target: https://travis-ci.org/pinax/pinax-forums
-
-.. image:: https://img.shields.io/coveralls/pinax/pinax-forums.svg
-    :target: https://coveralls.io/r/pinax/pinax-forums
-
-.. image:: https://img.shields.io/pypi/dm/pinax-forums.svg
-    :target:  https://pypi.python.org/pypi/pinax-forums/
 
 .. image:: https://img.shields.io/pypi/v/pinax-forums.svg
-    :target:  https://pypi.python.org/pypi/pinax-forums/
-
-.. image:: https://img.shields.io/badge/license-MIT-blue.svg
-    :target:  https://pypi.python.org/pypi/pinax-forums/
+    :target: https://pypi.python.org/pypi/pinax-forums/
 
+\ 
 
-Pinax
-------
+.. image:: https://img.shields.io/circleci/project/github/pinax/pinax-forums.svg
+    :target: https://circleci.com/gh/pinax/pinax-forums
+.. image:: https://img.shields.io/codecov/c/github/pinax/pinax-forums.svg
+    :target: https://codecov.io/gh/pinax/pinax-forums
+.. image:: https://img.shields.io/github/contributors/pinax/pinax-forums.svg
+    :target: https://github.com/pinax/pinax-forums/graphs/contributors
+.. image:: https://img.shields.io/github/issues-pr/pinax/pinax-forums.svg
+    :target: https://github.com/pinax/pinax-forums/pulls
+.. image:: https://img.shields.io/github/issues-pr-closed/pinax/pinax-forums.svg
+    :target: https://github.com/pinax/pinax-forums/pulls?q=is%3Apr+is%3Aclosed
 
-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.
-
-This app was developed as part of the Pinax ecosystem but is just a Django app
-and can be used independently of other Pinax apps.
+\ 
 
+.. image:: http://slack.pinaxproject.com/badge.svg
+    :target: http://slack.pinaxproject.com/
+.. image:: https://img.shields.io/badge/license-MIT-blue.svg
+    :target: https://pypi.python.org/pypi/pinax-forums/
 
-pinax-forums
--------------
+\ 
 
 ``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.
 
 See ``pinax-project-forums`` for a full Django project incorporating numerous
 apps with the goal of providing an out of the box forums solution.
-"""
 
+Supported Django and Python Versions
+------------------------------------
+
++-----------------+-----+-----+-----+-----+
+| Django / Python | 2.7 | 3.4 | 3.5 | 3.6 |
++=================+=====+=====+=====+=====+
+|  1.11           |  *  |  *  |  *  |  *  |
++-----------------+-----+-----+-----+-----+
+|  2.0            |     |  *  |  *  |  *  |
++-----------------+-----+-----+-----+-----+
+"""
 
 setup(
-    name="pinax-forums",
-    version="1.0.0",
     author="Pinax Team",
-    author_email="team@pinaxproject.com",
+    author_email="team@pinaxprojects.com",
     description="an extensible forum app for Django and Pinax",
+    name="pinax-forums",
     long_description=LONG_DESCRIPTION,
+    version=VERSION,
+    url="http://github.com/pinax/pinax-forums/",   
     license="MIT",
-    url="http://github.com/pinax/pinax-forums/",
     packages=find_packages(),
+    package_data={
+        "forums": []
+    },
     install_requires=[
         "django-appconf>=1.0.1",
-        "django-user-accounts==2.0.0"
+        "django-user-accounts==2.0.3"
     ],
     test_suite="runtests.runtests",
     tests_require=[
         "django-appconf>=1.0.1",
         "Django>=1.8",
-        "django-user-accounts==2.0.0"
+        "django-user-accounts==2.0.3"
     ],
     classifiers=[
         "Development Status :: 5 - Production/Stable",
@@ -85,4 +94,4 @@
         'Programming Language :: Python :: 3.6',
         "Topic :: Software Development :: Libraries :: Python Modules",
     ]
-)
+)