Merge pull request #52 from pinax/upgrading-docs

Upgrading docs and dropping support

Author: grahamu

.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

.gitignore

@@ -25,6 +25,10 @@ var/
 *.eggs
 .python-version
 
+# Pipfile
+Pipfile
+Pipfile.lock
+
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt

AUTHORS

@@ -11,3 +11,4 @@ Jacob Wegner
 Thomas Schreiber
 arthur
 Graham Ullrich
+Katherine “Kati” Michel

README.md

@@ -3,7 +3,6 @@
 # Pinax Likes
 
 [![](https://img.shields.io/pypi/v/pinax-likes.svg)](https://pypi.python.org/pypi/pinax-likes/)
-[![](https://img.shields.io/badge/license-MIT-blue.svg)](https://pypi.python.org/pypi/pinax-likes/)
 
 [![CircleCi](https://img.shields.io/circleci/project/github/pinax/pinax-likes.svg)](https://circleci.com/gh/pinax/pinax-likes)
 [![Codecov](https://img.shields.io/codecov/c/github/pinax/pinax-likes.svg)](https://codecov.io/gh/pinax/pinax-likes)
@@ -12,31 +11,51 @@
 [![](https://img.shields.io/github/issues-pr-closed/pinax/pinax-likes.svg)](https://github.com/pinax/pinax-likes/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)
 
+## 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)
+  * [Settings](#settings)
+  * [Templates](#templates)
+  * [Signals](#signals)
+  * [Filters](#filters)
+  * [TemplateTags](#template-tags)
+* [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-likes
 
 `pinax-likes` is a liking app for Django, allowing users to "like" and "unlike"
 any model instance in your project. Template tags provide the ability to see who
 liked an object, what objects a user liked, and more.
 
+### Overview
 
-## Table of Contents
+#### Supported Django and Python versions
+
+Django \ Python | 2.7 | 3.4 | 3.5 | 3.6
+--------------- | --- | --- | --- | ---
+1.11 |  *  |  *  |  *  |  *  
+2.0  |     |  *  |  *  |  *
 
-* [Installation](#installation)
-* [Usage](#usage)
-* [Settings](#settings)
-* [Templates](#templates)
-* [Signals](#signals)
-* [Filters](#filters)
-* [TemplateTags](#template-tags)
-* [Change Log](#change-log)
-* [About Pinax](#about-pinax)
-* [Contribute](#contribute)
-* [Code of Conduct](#code-of-conduct)
 
+## Documentation
 
-## Installation
+### Installation
 
 To install pinax-likes:
 
@@ -75,9 +94,9 @@ Lastly add `pinax.likes.urls` to your project urlpatterns:
     ]
 
 
-## Usage
+### Usage
 
-### Settings
+#### Settings
 
 Add each model that you want to be likable to the `PINAX_LIKES_LIKABLE_MODELS` setting:
 
@@ -87,7 +106,7 @@ Add each model that you want to be likable to the `PINAX_LIKES_LIKABLE_MODELS` s
         "biblion.Post": {},
     }
 
-### Templates
+#### Templates
 
 Let's say you have a detail page for a blog post. First load the template tags:
 
@@ -99,7 +118,7 @@ In the body where you want the liking widget to go, add:
 
 Finally, ensure you have `eldarion-ajax` installed:
 
-#### Eldarion AJAX
+##### Eldarion AJAX
 
 The `likes_widget` templatetag above and the "toggle like" view both conform
 to an `AJAX` response that [eldarion-ajax](https://github.com/eldarion/eldarion-ajax) understands.
@@ -120,34 +139,34 @@ you don't want `ajax` at all the view will handle a regular `POST` and
 perform a redirect.
 
 
-## Signals
+### Signals
 
 Both of these signals are sent from the `Like` model in the view that
 processes the toggling of likes and unlikes.
 
-### pinax.likes.signals.object_liked
+#### pinax.likes.signals.object_liked
 
 This signal is sent immediately after the object is liked and provides
 the single `kwarg` of `like` which is the created `Like` instance.
 
-### pinax.likes.signals.object_unliked
+#### pinax.likes.signals.object_unliked
 
 This signal is sent immediately after the object is unliked and provides
 the single `kwarg` of `object` which is the object that was just unliked.
 
 
-## Filters
+### Filters
 
-#### likes_count
+##### likes_count
 
 Returns the number of likes for a given object:
 
 
     {{ obj|likes_count }}
 
-## Template Tags
+### Template Tags
 
-### who_likes
+#### who_likes
 
 An assignment tag that fetches a list of likes for a given object:
 
@@ -157,7 +176,7 @@ An assignment tag that fetches a list of likes for a given object:
         <div class="like">{{ like.sender.get_full_name }} likes {{ car }}</div>
     {% endfor %}
 
-### likes
+#### likes
 
 The `likes` tag will fetch into a context variable a list of objects
 that the given user likes. This tag has two forms:
@@ -171,14 +190,14 @@ that the given user likes. This tag has two forms:
 
         {% likes user "app.Model" as objs %}
 
-#### Example:
+##### Example:
 
     {% likes request.user "app.Model" as objs %}
     {% for obj in objs %}
         <div>{{ obj }}</div>
     {% endfor %}
 
-### render_like
+#### render_like
 
 This renders a like. It combines well with the `likes` templatetag
 for showing a list of likes:
@@ -199,7 +218,7 @@ basis:
 -   `pinax/likes/app_name/like.html`
 -   `pinax/likes/_like.html`
 
-### likes_widget
+#### likes_widget
 
 This renders a fragment of HTML the user clicks on
 to unlike or like objects. It only has two required parameters,
@@ -212,7 +231,7 @@ A second form for this templatetag specifies the template to be rendered:
 
     {% likes_widget request.user post "pinax/likes/_widget_brief.html" %}
 
-### liked
+#### liked
 
 This template tag decorates an iterable of objects with a
 `liked` boolean indicating whether or not the specified
@@ -226,6 +245,11 @@ user likes each object in the iterable:
 
 ## ChangeLog
 
+## 3.0.0
+
+* Drop Django 1.8 and 1.10 support
+* Improve documentation
+
 ### 2.2.1
 
 * Correct LONG_DESCRIPTION app title
@@ -365,24 +389,32 @@ user likes each object in the iterable:
 -   Initial release
 
 
-## About Pinax
+## Contribute
 
-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.
+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.
 
-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!
+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.
 
-For updates and news regarding the Pinax Project, please follow us on Twitter at @pinaxproject and check out our [blog](http://blog.pinaxproject.com).
+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
 
-## Contribute
+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.
 
-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.
+## Connect with Pinax
 
-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/).
+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).
 
 
-## Code of Conduct
+## License
 
-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.
+Copyright (c) 2012-2018 James Tauber and contributors under the [MIT license](https://opensource.org/licenses/MIT).

pinax/likes/auth_backends.py

@@ -12,7 +12,7 @@ def is_allowed(self, obj):
 
     def has_perm(self, user, perm, obj=None):
         if perm == "likes.can_like":
-            if not user.is_authenticated():
+            if not user.is_authenticated:
                 return False
             return (self.is_allowed(obj) and per_model_perm_check(user, obj))
         return super(CanLikeBackend, self).has_perm(user, perm, obj)