Initial commit

LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2011, Eldarion, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+
+    * Neither the name of Eldarion, Inc. nor the names of its contributors may
+      be used to endorse or promote products derived from this software without
+      specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.rst

@@ -0,0 +1,11 @@
+marturion
+=========
+
+A testimonials app for your Django site.
+
+
+Documentation
+-------------
+
+Documentation can be found online at http://marturion.readthedocs.org/.
+

docs/Makefile

@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/agon_ratings.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/agon_ratings.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/agon_ratings"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/agon_ratings"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

docs/changelog.rst

@@ -0,0 +1,9 @@
+.. _changelog:
+
+ChangeLog
+=========
+
+0.1
+---
+
+- initial release

docs/conf.py

@@ -0,0 +1,21 @@
+extensions = []
+templates_path = []
+source_suffix = '.rst'
+master_doc = 'index'
+project = u'marturion'
+copyright = u'2011, Eldarion'
+version = '0.1'
+release = '0.1'
+exclude_patterns = ['_build']
+pygments_style = 'sphinx'
+html_theme = 'default'
+html_static_path = []
+htmlhelp_basename = 'marturiondoc'
+latex_documents = [
+  ('index', 'marturion.tex', u'marturion Documentation',
+   u'Eldarion', 'manual'),
+]
+man_pages = [
+    ('index', 'marturion', u'marturion Documentation',
+     [u'Eldarion'], 1)
+]

docs/index.rst

@@ -0,0 +1,22 @@
+=========
+marturion
+=========
+
+A simple testimonials app for your Django site.
+
+
+Development
+-----------
+
+The source repository can be found at https://github.com/eldarion/marturion
+
+
+Contents
+========
+
+.. toctree::
+ :maxdepth: 1
+
+ installation
+ usage
+ changelog

docs/installation.rst

@@ -0,0 +1,15 @@
+.. _installation:
+
+Installation
+============
+
+* To install agon_ratings::
+
+    pip install marturion
+
+* Add ``marturion`` to your ``INSTALLED_APPS`` setting::
+
+    INSTALLED_APPS = (
+        # other apps
+        "marturion",
+    )

docs/usage.rst

@@ -0,0 +1,21 @@
+.. _usage:
+
+Usage
+=====
+
+Using `marturion` is fairily straight forward. You consume quotes through the use
+of two different template tags. One that returns a queryset of all testimonials
+and one that returns a randomized queryset::
+
+    {% load marturion_tags %}
+    
+    {% random_testimonials as quotes %}
+
+    or::
+
+    {% load marturion_tags %}
+    
+    {% testimonials as quotes %}
+
+
+To input quotes, you simply add them through the Django admin.

marturion/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1"

marturion/admin.py

@@ -0,0 +1,10 @@
+from django.contrib import admin
+
+from marturion.models import Testimoninal
+
+
+class TestimoninalAdmin(admin.ModelAdmin):
+    list_display = ["id", "text", "added", "active"]
+
+
+admin.site.register(Testimoninal, TestimoninalAdmin)

marturion/models.py

@@ -0,0 +1,13 @@
+import datetime
+
+from django.db import models
+
+
+
+class Testimoninal(models.Model):
+
+    text = models.TextField()
+    author = models.CharField(max_length=100)
+    affiliation = models.CharField(max_length=100, blank=True)
+    added = models.DateTimeField(default=datetime.datetime.now)
+    active = models.BooleanField(default=False)

marturion/templatetags/marturion_tags.py

@@ -0,0 +1,44 @@
+from django import template
+
+from marturion.models import Testimoninal
+
+
+register = template.Library()
+
+
+class TestimonialsNode(template.Node):
+
+    @classmethod
+    def handle_token(cls, parser, token, order_by, **kwargs):
+        bits = token.split_contents()
+
+        if len(bits) != 3:
+            raise template.TemplateSyntaxError("%r takes exactly two arguments "
+                "(first argument must be 'as')" % bits[0])
+        if bits[1] != "as":
+            raise template.TemplateSyntaxError("Second argument to %r must be "
+                "'as'" % bits[0])
+
+        return cls(bits[2], order_by)
+
+    def __init__(self, context_var, order_by):
+        self.context_var = context_var
+        self.order_by = order_by
+
+    def render(self, context):
+        context[self.context_var] = Testimoninal.objects.filter(
+            active=True
+        ).order_by(
+            self.order_by
+        )
+        return u""
+
+
+@register.tag
+def random_testimonials(parser, token):
+    return TestimonialsNode.handle_token(parser, token, order_by="?")
+
+
+@register.tag
+def testimonials(parser, token):
+    return TestimonialsNode.handle_token(parser, token, order_by="-added")