Merge pull request #14 from pinax/updating-docs

Move documentation to README.md and Converting to CircleCI

.circleci/config.yml

@@ -0,0 +1,96 @@
+version: 2.0
+
+common: &common
+  working_directory: ~/repo
+  steps:
+    - checkout
+    - restore_cache:
+        keys:
+          - v2-deps-{{ .Environment.CIRCLE_JOB }}-{{ checksum "setup.py" }}-{{ checksum "tox.ini" }}
+          - v2-deps-
+    - run:
+        name: install dependencies
+        command: pip install --user tox
+    - run:
+        name: run tox
+        command: ~/.local/bin/tox
+    - run:
+        name: upload coverage report
+        command: |
+           if [[ "$UPLOAD_COVERAGE" != 0 ]]; then
+               PATH=$HOME/.local/bin:$PATH
+               pip install --user codecov
+               coverage xml
+               ~/.local/bin/codecov --required -X search gcov pycov -f coverage.xml --flags $CIRCLE_JOB
+           fi
+    - save_cache:
+        paths:
+          - .tox
+          - ~/.cache/pip
+          - ~/.local
+          - ./eggs
+        key: v2-deps-{{ .Environment.CIRCLE_JOB }}-{{ checksum "setup.py" }}-{{ checksum "tox.ini" }}
+
+jobs:
+  lint:
+    <<: *common
+    docker:
+      - image: circleci/python:3.6.1
+        environment:
+          - TOXENV=checkqa
+          - UPLOAD_COVERAGE=0
+  py27dj111:
+    <<: *common
+    docker:
+      - image: circleci/python:2.7
+        environment:
+          TOXENV=py27-dj111
+  py34dj111:
+    <<: *common
+    docker:
+      - image: circleci/python:3.4
+        environment:
+          TOXENV=py34-dj111
+  py34dj20:
+    <<: *common
+    docker:
+      - image: circleci/python:3.4
+        environment:
+          TOXENV=py34-dj20
+  py35dj111:
+    <<: *common
+    docker:
+      - image: circleci/python:3.5
+        environment:
+          TOXENV=py35-dj111
+  py35dj20:
+    <<: *common
+    docker:
+      - image: circleci/python:3.5
+        environment:
+          TOXENV=py35-dj20
+  py36dj111:
+    <<: *common
+    docker:
+      - image: circleci/python:3.6
+        environment:
+          TOXENV=py36-dj111
+  py36dj20:
+    <<: *common
+    docker:
+      - image: circleci/python:3.6
+        environment:
+          TOXENV=py36-dj20
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - lint
+      - py27dj111
+      - py34dj111
+      - py34dj20
+      - py35dj111
+      - py35dj20
+      - py36dj111
+      - py36dj20

.gitignore

@@ -1,10 +1,45 @@
-build
-dist
-.coverage
-.tox
 MANIFEST
-*.pyc
-*.egg-info
-*.egg
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
 docs/_build/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+*.eggs
+.python-version
+
+# Pipfile
+Pipfile
+Pipfile.lock
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
 htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# IDEs
+.idea/

AUTHORS

@@ -2,3 +2,4 @@ Patrick Altman
 James Tauber
 Anna Ossowski
 Graham Ullrich
+Katherine "Kati" Michel

README.md

@@ -1,47 +1,195 @@
+![](http://pinaxproject.com/pinax-design/patches/pinax-testimonials.svg)
+
 # Pinax Testimonials
 
-[![](http://slack.pinaxproject.com/badge.svg)](http://slack.pinaxproject.com/)
-[![](https://img.shields.io/travis/pinax/pinax-testimonials.svg)](https://travis-ci.org/pinax/pinax-testimonials)
-[![](https://img.shields.io/coveralls/pinax/pinax-testimonials.svg)](https://coveralls.io/r/pinax/pinax-testimonials)
-[![](https://img.shields.io/pypi/dm/pinax-testimonials.svg)](https://pypi.python.org/pypi/pinax-testimonials/)
 [![](https://img.shields.io/pypi/v/pinax-testimonials.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)
+[![](https://img.shields.io/github/contributors/pinax/pinax-testimonials.svg)](https://github.com/pinax/pinax-testimonials/graphs/contributors)
+[![](https://img.shields.io/github/issues-pr/pinax/pinax-testimonials.svg)](https://github.com/pinax/pinax-testimonials/pulls)
+[![](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/)
 
-## Pinax
+## 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)
 
-[Pinax](http://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.
+## 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.
 
-This app is part of the Pinax ecosystem and is designed for use both with and
-independently of other Pinax apps.
 
 ## 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.
 
-## Getting Started and Documentation
 
-Follow steps outlined in [Pinax Testimonials Documentation](https://github.com/pinax/pinax-testimonials/blob/master/docs/index.md).
+#### Supported Django and Python versions
 
-## Contribute
+Django \ Python | 2.7 | 3.4 | 3.5 | 3.6
+--------------- | --- | --- | --- | ---
+1.11 |  *  |  *  |  *  |  *  
+2.0  |     |  *  |  *  |  *
+
+
+## Documentation
+
+### Installation
+
+To install pinax-testimonials:
+
+    pip install pinax-testimonials
+
+Add `pinax-testimonials` to your `INSTALLED_APPS` setting:
+
+    INSTALLED_APPS = (
+        ...
+        "pinax.testimonials",
+        ...
+    )
+
+### 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.
+
+First, load the template tags:
+
+    {% load pinax_testimonials_tags %}
+
+For random testimonials:
+
+    {% random_testimonials <number> as quotes %}
+
+For testimonials ordered by the date they were added:
+
+    {% testimonials <number> as quotes %}
+
+For show all testimonials by ordered the date:, just remove number parameter, like this:
+
+    {% testimonials as quotes %}
+
+If you just want a single random testimonial you can use:
+
+    {% random_testimonial as quote %}
+
+And there is an example that how you can show the testimonials, you can do something like this:
+
+    {% testimonials  as quotes %}
+        {% for quote in quotes %}
+        <p class="lead">
+            {{quote.text}}
+            {{quote.author}}
+        </p>
+        {% endfor %}
 
-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.
+Add and manage testimonial quotes via the Django admin.
 
-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/).
+## Change Log
 
+### 2.0.1
+
+* Standardize documentation layout
+* Drop Django v1.8, v1.10 support
+
+### 2.0.0
+
+* Add Django 2.0 compatibility testing
+* Drop Django 1.9 and Python 3.3 support
+* Convert CI and coverage to CircleCi and CodeCov
+* Add PyPi-compatible long description
+* Move documentation to README.md
+
+### 1.0.5
+
+* Update this change log
+
+### 1.0.4
+
+* Documentation updates
+
+### 1.0.3
+
+* Rename templatetags file to match Pinax convention
+* Add tests
+* Add initial migration
+* Update documentation
+
+### 1.0
+
+* Updated template tags to use `assignment_tags`
+* Added bulk operations to admin to mark testimonials as active/inactive
+* Renamed from `marturian` to `pinax-testimonials` during the donation from Eldarion to Pinax
+
+### 0.2
+
+* Fixed documenation bug
+* Added a template tag for fetching a single random quote
+
+### 0.1.4
+
+* Fixed bug introduction with last bug fix.
+
+### 0.1.3
+
+* Fix bug where the random query select would make it hard to use queryset in a template using index accessors.
+
+### 0.1.2
+
+* Fixed a typo in the model name
+
+### 0.1
+
+* initial release
+
+
+## Contribute
+
+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 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.
+
+
+## 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 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).