Dropping Django 1.8 and 1.10 and standardizing docs

pinax · Dec 17, 2017 · be4acee · be4acee
1 parent c3fe049
commit be4acee
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 80 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -39,36 +39,12 @@ jobs:
         environment:
           - TOXENV=checkqa
           - UPLOAD_COVERAGE=0
-  py27dj18:
-    <<: *common
-    docker:
-      - image: circleci/python:2.7
-        environment:
-          TOXENV=py27-dj18
-  py27dj110:
-    <<: *common
-    docker:
-      - image: circleci/python:2.7
-        environment:
-          TOXENV=py27-dj110
   py27dj111:
     <<: *common
     docker:
       - image: circleci/python:2.7
         environment:
           TOXENV=py27-dj111
-  py34dj18:
-    <<: *common
-    docker:
-      - image: circleci/python:3.4
-        environment:
-          TOXENV=py34-dj18
-  py34dj110:
-    <<: *common
-    docker:
-      - image: circleci/python:3.4
-        environment:
-          TOXENV=py34-dj110
   py34dj111:
     <<: *common
     docker:
@@ -81,18 +57,6 @@ jobs:
       - image: circleci/python:3.4
         environment:
           TOXENV=py34-dj20
-  py35dj18:
-    <<: *common
-    docker:
-      - image: circleci/python:3.5
-        environment:
-          TOXENV=py35-dj18
-  py35dj110:
-    <<: *common
-    docker:
-      - image: circleci/python:3.5
-        environment:
-          TOXENV=py35-dj110
   py35dj111:
     <<: *common
     docker:
@@ -123,15 +87,9 @@ workflows:
   test:
     jobs:
       - lint
-      - py27dj18
-      - py27dj110
       - py27dj111
-      - py34dj18
-      - py34dj110
       - py34dj111
       - py34dj20
-      - py35dj18
-      - py35dj110
       - py35dj111
       - py35dj20
       - py36dj111

diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,7 @@ MANIFEST
 __pycache__/
 *.py[cod]
 
+
 # Distribution / packaging
 .Python
 env/

diff --git a/README.md b/README.md
@@ -3,7 +3,6 @@
 # Pinax Testimonials
 
 [![](https://img.shields.io/pypi/v/pinax-testimonials.svg)](https://pypi.python.org/pypi/pinax-testimonials/)
-[![](https://img.shields.io/badge/license-MIT-blue.svg)](https://pypi.python.org/pypi/pinax-testimonials/)
 
 [![CircleCi](https://img.shields.io/circleci/project/github/pinax/pinax-testimonials.svg)](https://circleci.com/gh/pinax/pinax-testimonials)
 [![Codecov](https://img.shields.io/codecov/c/github/pinax/pinax-testimonials.svg)](https://codecov.io/gh/pinax/pinax-testimonials)
@@ -12,33 +11,50 @@
 [![](https://img.shields.io/github/issues-pr-closed/pinax/pinax-testimonials.svg)](https://github.com/pinax/pinax-testimonials/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://pypi.python.org/pypi/pinax-testimonials/)
+
+## Table of Contents
+
+* [About Pinax](#about-pinax)
+* [Overview](#overview)
+  * [Supported Django and Python versions](#supported-django-and-python-versions)
+* [Documentation](#documentation)
+  * [Installation](#installation)
+  * [Usage](#usage)
+* [Change Log](#change-log)
+* [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-testimonials
 
+### Overview
+
 `pinax-testimonials` is a well tested, documented, and proven solution
 for any site wanting to display testimonials.
 
 Testimonials contain text by an author with an optional organization affiliation.
 For display, testimonials are retrieved randomly or most recent first.
 
 
-### Supported Django and Python Versions
-
-* Django 1.8, 1.10, 1.11, and 2.0
-* Python 2.7, 3.4, 3.5, and 3.6
-
+#### Supported Django and Python versions
 
-## Table of Contents
+Django \ Python | 2.7 | 3.4 | 3.5 | 3.6
+--------------- | --- | --- | --- | ---
+1.11 |  *  |  *  |  *  |  *  
+2.0  |     |  *  |  *  |  *
 
-* [Installation](#installation)
-* [Usage](#usage)
-* [Changelog](#changelog)
-* [Contribute](#contribute)
-* [Code of Conduct](#code-of-conduct)
-* [About Pinax](#about-pinax)
 
+## Documentation
 
-## Installation
+### Installation
 
 To install pinax-testimonials:
 
@@ -52,7 +68,7 @@ Add `pinax-testimonials` to your `INSTALLED_APPS` setting:
         ...
     )
 
-## Usage
+### Usage
 
 In your template where you want to display testimonials there are three ways you
 can use template tags to add active testimonials to your page.
@@ -90,7 +106,12 @@ And there is an example that how you can show the testimonials, you can do somet
 Add and manage testimonial quotes via the Django admin.
 
 
-## Changelog
+## Change Log
+
+### 2.0.1
+
+* Standardize documentation layout
+* Drop Django v1.8, v1.10 support
 
 ### 2.0.0
 
@@ -145,22 +166,30 @@ Add and manage testimonial quotes via the Django admin.
 
 ## Contribute
 
-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.
+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.
-
-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 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.
 
+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/).
 
 ## Code of Conduct
 
-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.
+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.
 
 
-## About Pinax
+## Connect with Pinax
+
+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 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.
 
-The Pinax documentation is available at http://pinaxproject.com/pinax/. If you would like to help us improve our documentation or write more documentation, please join our Pinax Project Slack team and let us know!
+## 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/testimonials/templatetags/pinax_testimonials_tags.py b/pinax/testimonials/templatetags/pinax_testimonials_tags.py
@@ -5,17 +5,17 @@
 register = template.Library()
 
 
-@register.assignment_tag
+@register.simple_tag
 def random_testimonials(number):
     return Testimonial.objects.filter(active=True).order_by("?")[:number]
 
 
-@register.assignment_tag
+@register.simple_tag
 def random_testimonial():
     queryset = Testimonial.objects.filter(active=True).order_by("?")
     return queryset[0] if queryset else None
 
 
-@register.assignment_tag
+@register.simple_tag
 def testimonials(number):
     return Testimonial.objects.filter(active=True).order_by("-added")[:number]
diff --git a/setup.py b/setup.py
@@ -32,8 +32,13 @@
 Supported Django and Python Versions
 ------------------------------------
 
-* Django 1.8, 1.10, 1.11, and 2.0
-* Python 2.7, 3.4, 3.5, and 3.6
++-----------------+-----+-----+-----+-----+
+| Django \ Python | 2.7 | 3.4 | 3.5 | 3.6 |
++=================+=====+=====+=====+=====+
+| 1.11            |  *  |  *  |  *  |  *  |
++-----------------+-----+-----+-----+-----+
+| 2.0             |     |  *  |  *  |  *  |
++-----------------+-----+-----+-----+-----+
 """
 
 setup(
@@ -42,7 +47,7 @@
     description="a testimonials app",
     name="pinax-testimonials",
     long_description=LONG_DESCRIPTION,
-    version="2.0.0",
+    version="2.0.1",
     url="http://github.com/pinax/pinax-testimonials/",
     license="MIT",
     packages=find_packages(),
@@ -65,8 +70,6 @@
         "Development Status :: 5 - Production/Stable",
         "Environment :: Web Environment",
         "Framework :: Django",
-        'Framework :: Django :: 1.8',
-        'Framework :: Django :: 1.10',
         'Framework :: Django :: 1.11',
         'Framework :: Django :: 2.0',
         "Intended Audience :: Developers",

diff --git a/tox.ini b/tox.ini
@@ -27,18 +27,16 @@ show_missing = True
 [tox]
 envlist =
     checkqa,
-    py27-dj{18,110,111}
-    py34-dj{18,110,111,20}
-    py35-dj{18,110,111,20}
+    py27-dj{111}
+    py34-dj{111,20}
+    py35-dj{111,20}
     py36-dj{111,20}
 
 [testenv]
 passenv = CI CIRCLECI CIRCLE_*
 deps =
     coverage
     codecov
-    dj18: Django>=1.8,<1.9
-    dj110: Django>=1.10,<1.11
     dj111: Django>=1.11,<1.12
     dj20: Django<2.1
     master: https://github.com/django/django/tarball/master