LICENCE

+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 [Copyright holder]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

MANIFEST.in

+include LICENCE
+recursive-include django_starfield/static *
+recursive-include django_starfield/templates *
+recursive-include example *.py *.html

README.rst

@@ -8,6 +8,16 @@ This is a simple widget rendering so-called rating stars as input for an
 integer field. It is based solely on CSS 3, as laid out by `Martin Ivanov
 <http://experiments.wemakesites.net/css3-rating-stars-with-selection.html>`_.
 
+This is different from other star rating applications in that it provides
+only a widget returning its selction to any IntegerField. It is not a
+complete rating application, just a presentational widget for integer input.
+It is also different in that it depends only on CSS3, without any
+JavaScript.
+
+In contrast to others (and to the original work credited above), this widget
+also works on browsers that do not support CSS (like text-mode browsers). In
+that case, it renders as basic radio buttons with numbers.
+
 Usage
 -----
 
@@ -19,16 +29,20 @@ Just add the Stars widget to any IntegerField in a Django form.
   from django_starfield import Stars
 
   class StarsExampleForm(forms.Form):
-      rating = forms.IntegerField(widget=Stars())
-
-You can change the number of stars by passing the stars argument to the
-Stars widget.
-
-Differences
------------
-
-This is different from other star rating applications in that it provides
-only a widget returning its selction to any IntegerField. It is not a
-complete rating application, just a presentational widget for integer input.
-It is also different in that it depends only on CSS3, without any
-JavaScript.
+      rating = forms.IntegerField(widget=Stars)
+
+The following aspects are configurable, both in the Django settings and when
+creating the widget (by passing an argument to Stars):
+
++------------------------+-----------------------+---------+---------------------+-----------+
+| Aspect                 | Format                | Default | Setting name        | Argument  |
++========================+=======================+=========+=====================+===========+
+| Number of stars        | integer               | 5       | STARFIELD_STARS     | stars     |
++------------------------+-----------------------+---------+---------------------+-----------+
+| Character used as star | hexadecimal codepoint | 2605    | STARFIELD_CODEPOINT | codepoint |
++------------------------+-----------------------+---------+---------------------+-----------+
+| Colour of stars        | HTML colour           | #f5b301 | STARFIELD_COLOUR    | colour    |
++------------------------+-----------------------+---------+---------------------+-----------+
+
+Please note that some browsers render some Unicode characters, especially
+emojis, as images, so changing the font colour will not work.

django_starfield/static/django_starfield.css

+/*
+ * Selectable CSS3 Rating Stars by Martin Ivanov (@wemakesitesnet)
+ * @version 1.0
+ * @author Martin Ivanov
+ * @url portfolio http://wemakesites.net/
+ * @url twitter https://twitter.com/wemakesitesnet
+ * @url blog http://acidmartin.wordpress.com/
+ **/
+
+/* Work was allegedly released into the public domain,
+ * as laid out by e-mail.
+ */
+
+.django-starfield,
+.django-starfield label::before
+{
+    display: inline-block;
+}
+ 
+.django-starfield label:hover,
+.django-starfield label:hover ~ label
+{
+    filter: grayscale(0.5);;
+}
+ 
+.django-starfield *
+{
+    margin: 0;
+    padding: 0;
+}
+ 
+.django-starfield input
+{
+    display: none;
+}
+
+.django-starfield
+{
+    unicode-bidi: bidi-override;
+    direction: rtl;
+}
+ 
+.django-starfield label
+{
+    color: #f5b301;
+    filter: grayscale(1);
+}
+ 
+.django-starfield label::before
+{
+    content: '\2605';
+    width: 18px;
+    line-height: 18px;
+    text-align: center;
+    font-size: 18px;
+    cursor: pointer;
+}
+
+.django-starfield label span
+{
+    display: none;
+}
+ 
+.django-starfield input:checked ~ label
+{
+    filter: grayscale(0);
+}

django_starfield/templates/django_starfield/stars.html

-{% for i in stars %}<!--
---><input type="radio" name="{{ name }}" id="{{ name }}-{{ forloop.counter0 }}"
-          value="{{ i }}" {% if value == i %}checked="checked"{% endif %} /><!--
-    --><label for="{{ name }}-{{ forloop.counter0 }}">{{ i }}</label><!--
--->{% endfor %}
+{% load static %}
+<div class="django-starfield" id="django-starfield-{{ widget.name }}">
+ {% for i in stars %}
+  <input type="radio" name="{{ widget.name }}" id="{{ widget.name }}-{{ forloop.counter0 }}"
+         value="{{ i }}" {% ifequal widget.value i|stringformat:'i' %}checked="checked"{% endifequal %} />
+  <label for="{{ widget.name }}-{{ forloop.counter0 }}"><span>{{ i }}</span></label>
+ {% endfor %}
+</div>
+<link rel="stylesheet" href="{% static 'django_starfield.css' %}" />
+{% if codepoint %}
+<style type="text/css">
+ #django-starfield-{{ widget.name }} label::before {
+  content: '\{{ codepoint }}';
+ }
+</style>
+{% endif %}
+{% if colour %}
+<style type="text/css">
+ #django-starfield-{{ widget.name }} label {
+  color: {{ colour }};
+ }
+</style>
+{% endif %}

django_starfield/widgets.py

-from django.forms.widget import Widget
+from django.conf import settings
+from django.forms.widgets import Widget
+
+STARFIELD_COLOUR = '#f5b301'
+STARFIELD_CODEPOINT = '2605'
+STARFIELD_STARS = 5
 
 class Stars(Widget):
     template_name = 'django_starfield/stars.html'
 
-    def __init__(self, attrs=None, stars=5, codepoint='2605'):
+    def __init__(self, attrs=None, stars=None, codepoint=None, colour=None):
         super(Stars, self).__init__(attrs)
-        self.stars = 5
-        self.codepoint = '2605'
+
+        self.stars = stars if stars else getattr(settings, 'STARFIELD_STARS', STARFIELD_STARS)
+        self.codepoint = codepoint if codepoint else getattr(settings, 'STARFIELD_CODEPOINT', STARFIELD_CODEPOINT)
+        self.colour = colour if colour else getattr(settings, 'STARFIELD_COLOUR', STARFIELD_COLOUR)
 
     def get_context(self, name, value, attrs):
         context = super(Stars, self).get_context(name, value, attrs)
         context['stars'] = range(self.stars, 0, -1)
+        if not self.codepoint == STARFIELD_CODEPOINT:
+            context['codepoint'] = self.codepoint
+        if not self.colour == STARFIELD_COLOUR:
+            context['colour'] = self.colour
         return context

example/example/forms.py

+from django import forms
+from django_starfield import Stars
+
+class RatingForm(forms.Form):
+    rating_1 = forms.IntegerField(label='Default rating', widget=Stars)
+    rating_2 = forms.IntegerField(label='Big rating', widget=Stars(stars=17))
+    rating_3 = forms.IntegerField(label='Pink rating', widget=Stars(colour='#ff1493'))
+    rating_4 = forms.IntegerField(label='Dolphin rating', widget=Stars(codepoint='1f42c'))

example/example/settings.py

+"""
+Django settings for example project.
+
+Generated by 'django-admin startproject' using Django 2.0.7.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/2.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/2.0/ref/settings/
+"""
+
+import os
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/2.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'kn+=4+#i($pch$5tgq2-teo&w14zrwlgb0#t=kcb@w*v7^h0ll'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.contenttypes',
+    'django.contrib.staticfiles',
+    'django_starfield',
+    'example'
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'example.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'example.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/2.0/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+    }
+}
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/2.0/howto/static-files/
+
+STATIC_URL = '/static/'

example/example/templates/form.html

+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>django_starfield example</title>
+  </head>
+  <body>
+   <form method="post">
+    {% csrf_token %}
+    <table>
+     {{ rating_form.as_table }}
+    </table>
+    <input type="submit" value="Submit" />
+   </form>
+  </body>
+</html>

example/example/urls.py

+from django.conf.urls import url
+from . import views
+
+urlpatterns = [
+    url(r'^$', views.form)
+]

example/example/views.py

+from django.shortcuts import render
+
+from .forms import RatingForm
+
+def form(request):
+    if request.method == 'POST':
+        rating_form = RatingForm(request.POST)
+    else:
+        rating_form = RatingForm()
+
+    return render(request, 'form.html', {'rating_form': rating_form})

example/example/wsgi.py

+"""
+WSGI config for example project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/2.0/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example.settings")
+
+application = get_wsgi_application()

example/manage.py

+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)

setup.py

+import os
+from setuptools import setup
+
+MYDIR = os.path.dirname(__file__)
+
+setup(
+    name='django-starfield',
+    version='1.0.post2',
+    keywords = ['django', 'forms', 'widget', 'rating'],
+    description = 'A no-frills Django form widget for rating stars',
+    long_description = open(os.path.join(MYDIR, "README.rst"), "r", encoding="utf-8").read(),
+    url = 'https://edugit.org/AlekSIS/libs/django-starfield',
+    author='Dominik George',
+    author_email='dominik.george@teckids.org',
+    packages=['django_starfield'],
+    include_package_data=True,
+    install_requires=['Django>=1.11'],
+    classifiers=[
+        'Environment :: Web Environment',
+        'Framework :: Django',
+        'Framework :: Django :: 1.11',
+        'Framework :: Django :: 2.0',
+        'Framework :: Django :: 2.1',
+        'License :: OSI Approved :: Apache Software License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 3',
+        'Topic :: Internet :: WWW/HTTP',
+        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
+    ],
+)