From fdb371d7341d69cd076903017ba8d76c8ed8e359 Mon Sep 17 00:00:00 2001 From: Tom Walker Date: Tue, 1 Jul 2014 13:02:14 +0100 Subject: [PATCH] added readme.rst for Pypi --- .gitignore | 1 + README.md | 31 +++++++++-------- README.rst | 98 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ setup.py | 4 +-- 4 files changed, 119 insertions(+), 15 deletions(-) create mode 100644 README.rst diff --git a/.gitignore b/.gitignore index d870ef6..3153618 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ /plan.txt /dist* *.egg-info* +build* \ No newline at end of file diff --git a/README.md b/README.md index 39439e2..6d3e525 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ the template files that are dependant on bootstrap. ![Questions](http://i.imgur.com/VRYx3OV.png "Question picture hosted by Imgur") + Current features ---------------- Features of each quiz: @@ -25,6 +26,7 @@ Features of each quiz: * Multiple choice question type * True/False question type + ![Result page](http://i.imgur.com/UJtRZxo.png "Result picture hosted by Imgur") Requirements @@ -41,25 +43,28 @@ Run `pip install -r requirements.txt`. Add `'quiz', 'multichoice', 'true_false',` to your `INSTALLED_APPS` setting. -`INSTALLED_APPS = ( - ... - 'quiz', - 'multichoice', - 'true_false', - ... -)` + INSTALLED_APPS = ( + ... + 'quiz', + 'multichoice', + 'true_false', + ... + ) Add the following to your projects `urls.py` file, substituting `q` for whatever you want the quiz base url to be. -`urlpatterns = patterns('', - ... - url(r'^q/', include('quiz.urls')), - ... -)` + urlpatterns = patterns('', + ... + url(r'^q/', include('quiz.urls')), + ... + ) + + + This is my first open source project so please forgive any problems and/or dreadful code! MIT License (MIT) -Copyright (c) 2013 Dr Tom Walker +Copyright (c) 2012 - 2014 Dr Tom Walker Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..8d60721 --- /dev/null +++ b/README.rst @@ -0,0 +1,98 @@ +Django quiz app +=============== + +This is a configurable quiz app for Django. + +I use it to run a few medical revision websites. Here is an `example +website`_ + +My websites have used twitter bootstrap for the front end and I have +tried to strip out anything from the template files that are dependant +on bootstrap. + +.. figure:: http://i.imgur.com/VRYx3OV.png + :alt: Question picture hosted by Imgur + + Questions +Current features +---------------- + +Features of each quiz: \* Question order randomisation \* Storing of +quiz results under each user \* Previous quiz scores can be viewed on +category page \* Correct answers can be shown after each question or all +at once at the end \* Logged in users can return to an incomplete quiz +to finish it and non-logged in users can complete a quiz if their +session persists \* The quiz can be limited to one attempt per user \* +Questions can be given a category \* Success rate for each category can +be monitored on a progress page \* Explanation for each question result +can be given \* Multiple choice question type \* True/False question +type + +.. figure:: http://i.imgur.com/UJtRZxo.png + :alt: Result picture hosted by Imgur + + Result page +Requirements +------------ + +django-model-utils 2.0.3 + +It was developed using Django 1.6.5 + +Installation +------------ + +Clone the repo with +``git clone https://github.com/tomwalker/django_quiz.git``. + +Run ``pip install -r requirements.txt``. + +Add ``'quiz', 'multichoice', 'true_false',`` to your ``INSTALLED_APPS`` +setting. + +:: + + INSTALLED_APPS = ( + ... + 'quiz', + 'multichoice', + 'true_false', + ... + ) + +Add the following to your projects ``urls.py`` file, substituting ``q`` +for whatever you want the quiz base url to be. + +:: + + urlpatterns = patterns('', + ... + url(r'^q/', include('quiz.urls')), + ... + ) + +This is my first open source project so please forgive any problems +and/or dreadful code! + +MIT License (MIT) Copyright (c) 2012 - 2014 Dr Tom Walker + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the +“Software”), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS +OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +.. _example website: http://www.revisemrcp.com/ diff --git a/setup.py b/setup.py index d66ef4f..5b295c1 100644 --- a/setup.py +++ b/setup.py @@ -1,13 +1,13 @@ import os from setuptools import setup -README = open(os.path.join(os.path.dirname(__file__), 'README.md')).read() +README = open(os.path.join(os.path.dirname(__file__), 'README.rst')).read() os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir))) setup( name='django-quiz-app', - version='0.3', + version='0.3.0', packages=['quiz', 'multichoice', 'true_false'], include_package_data=True, license='MIT License', -- 2.39.5