django-renderit Documentation

Size: px
Start display at page:

Download "django-renderit Documentation"

Transcription

1 django-renderit Documentation Release 1.2 jsoares Nov 20, 2017

2

3 Contents 1 Installation 3 2 Getting Started Basic Usage Extra Arguments Python Objects Fallback Site Specific Template Tags renderit Template Fallback Simple Example Arguments Example The other arguments Settings CONCATINATION_STRING ROOT_TEMPLATE_PATH DEBUG SITE_GROUPS SITE_GET_FUNC Contributing 23 7 Indices and tables 25 i

4 ii

5 django-renderit is a easy way to render objects. Contents: Contents 1

6 2 Contents

7 CHAPTER 1 Installation Installation is easy using pip or easy_install. pip install django-renderit or easy_install django-renderit Add renderit to your installed apps: INSTALLED_APPS = (... 'renderit',... ) 3

8 4 Chapter 1. Installation

9 CHAPTER 2 Getting Started The idea here is to take a object and render it based off of its content type. django-renderit is one template tag called renderit and it takes a bunch of different parameters to determine what template to render. 2.1 Basic Usage {% load renderit %} {% renderit object %} This will render object using the default template, which is: '/renderit/default.html' You can then create a template that is object specific, for example, if the object is a auth.user instance, it will look for this template: '/renderit/auth_user.html' 2.2 Extra Arguments We can add extra arguments to further make this template unique, for example, lets say we want to render the authentication information for websites that required logged in users. We would normally have some html on our base template, such as <html> <head>mysite</head> <body> <div class="auth"> 5

10 Welcome, {% if request.user.is_authenticated %} {{ request.user.username }}, <a href="/profile/">profile</a> <a href= "/logout/">logout</a> {% else %} Guest, <a href="/login/">login</a> or <a href="/register/">register</ a> {% endif %} </div> <div class="content">... </div> </body> </html> renderit s goal is to take these little blocks of code and seperate them out in there own specific, resuable templates, and to clean up the main templates. {% load renderit %} <html> <head>mysite</head> <body> {% renderit request.user auth %} <div class="content">... </div> </body> </html> The above example takes an extra argument auth, this can be a context variable or taken literally. If auth not a variable in the template then renderit will take is as a string: '/renderit/auth_user_auth.html' Any arguments specified after the object, will be appended to the end of the template name. While the above example can be used with django s include tag in the same way, a better use case would be when your dealing with a list of gerneric objects. Lets take the following models: class DummyEntry(models.Model): title = models.charfield(max_length=200) body = models.textfield() publish_date = models.datetimefield(default=datetime.datetime.now) author = models.charfield(max_length=200) def unicode (self): return self.title class DummyBookmark(models.Model): url = models.urlfield() name = models.charfield(max_length=200) class DummyVideo(models.Model): url = models.urlfield() 6 Chapter 2. Getting Started

11 name = models.charfield(max_length=200) class DummyImage(models.Model): url = models.urlfield() name = models.charfield(max_length=200) class RelatedContent(models.Model): entry = models.foreignkey(dummyentry) content_type = models.foreignkey(contenttype) object_id = models.integerfield() content_object = generic.genericforeignkey('content_type', 'object_id') add_date = models.datetimefield(default=datetime.datetime.now) Lets create and add the content to a generic list: bm_ctype = ContentType.objects.get_for_model(DummyBookmark) vi_ctype = ContentType.objects.get_for_model(DummyVideo) im_ctype = ContentType.objects.get_for_model(DummyImage) en_ctype = ContentType.objects.get_for_model(DummyEntry) entry = DummyEntry.objects.create( title="this is an example entry", body="this is only an example entry", author="john Smith") bm = DummyBookmark.objects.create( url=" name="google") vid = DummyVideo.objects.create( url=" ", name="django's Caravan - Gypsy Jazz Guitar - Leigh Jackson") img1 = DummyImage.objects.create( url=" name="fair Exchange From alison lyons photography") RelatedContent.objects.create( entry=entry, content_type=bm_ctype, object_id=bm.pk) RelatedContent.objects.create( entry=entry, content_type=vi_ctype, object_id=vid.pk) RelatedContent.objects.create( entry=entry, content_type=im_ctype, object_id=img.pk) RelatedContent.objects.create( entry=entry, 2.2. Extra Arguments 7

12 content_type=en_ctype, object_id=entry.pk) related_objects = RelatedContent.objects.all() When related_content is used in your template, there will be 4 different types of objects. If we dont want they all to look the same, for example have a image show up for DummyImage types or embdeded video player for DummyVideo types, the way we can do that is to have a bunch of if statements to check the type of object, but thats ugly, and can clutter up the template. Enstead renderit will know the type of object you are trying to render and use the appropriete template. {% for obj in related_content %} {% renderit obj %} {% endfor %} When we output the template list that is created for each item in the loop above, it will look something like this: [u'renderit/sample_app_dummybookmark.html', 'renderit/default.html'] [u'renderit/sample_app_dummyvideo.html', 'renderit/default.html'] [u'renderit/sample_app_dummyimage.html', 'renderit/default.html'] [u'renderit/sample_app_dummyentry.html', 'renderit/default.html'] We can then create the templates and make them custom to the type of object. 2.3 Python Objects While the examples shown are specific to django models, we can pass in any object and its type will be used (slugified) to build the template. If we have a python dictionary, the template will be: '/renderit/dict.html' Of course this is rather broad, so we should pass in extra arguments to ensure its specific to what we use it for {% renderit dict_obj top10 %} The template that will be looked for first would be: '/renderit/dict_top10.html' Read more about Template Tags 2.4 Fallback Fallback template paths are generated based on the arguments supplied, which the last possbiel template being /renderit/default.html. Read more about Template Fallback 2.5 Site Specific In the event you are using sites, and the templates you need rendered are structurally different, you can enable site groups to further distingish the templates that are rendered. 8 Chapter 2. Getting Started

13 This is similar to how groups are parsed, but they fallback to the non-site specific templates if not found. Here is an example of the template difference between site and non-site: 'renderit/section/sample_app_video.html' And want to create a site specific template: 'renderit/1/section/sample_app_video.html' We need to either specify site=true in the template tag or enable sites for all templates using the setting SITE_GROUPS and setting it to True This differs from groups in that they fallback to the non-site specific templates. For example, groups generate a template list like the following: ['renderit/<group1>/<group2>/<template_name>', 'renderit/<group1>/<template_name>', 'renderit/<template_name>'] When sites are enabled for the same scenario produces the following template list: ['renderit/<site>/<group1>/<group2>/<template_name>', 'renderit/<site>/<group1>/<template_name>', 'renderit/<site>/<template_name>', 'renderit/<group1>/<group2>/<template_name>', 'renderit/<group1>/<template_name>', 'renderit/<template_name>'] Key thing to take away from this, is that we can create templates without any care for sites initially, which may act as defaults, then we can override templates for specific sites Site Specific 9

14 10 Chapter 2. Getting Started

15 CHAPTER 3 Template Tags Contents Template Tags renderit * Syntax * Examples * arguments 3.1 renderit Syntax {% renderit [object] [arg] [arg]... [with] [group=s] [prefix=s] [concat=s] [context=true False] [site=true False] [as] [varname] %} Examples Simplest Form: {% renderit request.user %} Multiple Arguments: {% renderit request.user auth custom %} 11

16 With Prefix {% renderit request.user auth custom with prefix=header %} Change concatination string to be (double under score) {% renderit request.user auth custom with prefix=header concat=" " %} arguments object Only required argument, can be any python object. args Anything specified after [object] and before [with] will be treated as extra concatination strings. These can also be context variables. Note: If an object is resolved and contains a space, the argument will be slugified, using django.template. defaultfilters.slugify with Required only if [group], [prefix] or [concat] is used. group This value is used to better structure the template location. A folder with the supplied value will be preprened to template path. Example {% renderit auth.user with group='users' %} Template path built: '/renderit/users/auth_user.html' prefix Prefixes the template with supplied value. Example {% renderit auth.user with prefix='users' %} Template path built: 12 Chapter 3. Template Tags

17 '/renderit/users_auth_user.html' concat Change the default concatination string when building templates, default is _ (underscore) Example {% renderit auth.user with concat=" " %} Template path built: '/renderit/auth users.html' Note: The default concatination string can be changed using CONCATINATION_STRING context If True (default) the template context will be passed into the template. site If True the site will be used to add additional possible templates on a per site basis Example {% renderit auth.user with site=true %} as Only required if a return variable is used. varname Store the rendered template into a context varaible. Example {% renderit auth.user as auth_var %} {{ auth_var }} 3.1. renderit 13

18 14 Chapter 3. Template Tags

19 CHAPTER 4 Template Fallback Contents Template Fallback Simple Example Arguments Example * Single Argument * Mulitple Arguments * Prefix * Group * Site * Combined The other arguments * concat Fallback template paths are generated based on the arguments supplied. select_template is called on the list. A list templates is created and then 4.1 Simple Example {% renderit auth.user %} Generated List: 15

20 ['/renderit/auth_user.html', '/renderit/default.html'] Note: The default template root path can be changed via ROOT_TEMPLATE_PATH 4.2 Arguments Example Single Argument {% renderit auth.user auth %} Generated list: ['/renderit/auth_user_auth.html', '/renderit/auth_user.html', '/renderit/default.html'] Mulitple Arguments {% renderit auth.user auth homepage %} Generated list: ['/renderit/auth_user_auth_homepage.html', '/renderit/auth_user_auth.html', '/renderit/auth_user.html', '/renderit/default.html'] Prefix Suppling a prefix will gerernate two sets of templates, one set with the prefix and one set without the prefix {% renderit auth.user with prefix=userinfo %} Generated List: ['/renderit/userinfo_auth_user.html', '/renderit/auth_user.html', '/renderit/default.html'] With Arguments {% renderit auth.user homepage custom with prefix=userinfo %} Generated List: 16 Chapter 4. Template Fallback

21 ['/renderit/userinfo_auth_user_homapage_custom.html', '/renderit/userinfo_auth_user_homepage.html', '/renderit/userinfo_auth_user.html', '/renderit/auth_user_homepage_custom.html', '/renderit/auth_user_homapage.html', '/renderit/auth_user.html', '/renderit/default.html'] Group Changed in version 1.1 Group will append the string and act like a directory rather then a extra template path string. {% renderit auth.user with group=users %} Generated List: ['/renderit/users/auth_user.html', '/renderit/auth_user.html', '/renderit/default.html'] The group argument can also be a path i.e. users/homepage New in version 1.1 {% renderit auth.user with group=users/homepage %} Generated List: ['/renderit/users/homepage/auth_user.html', '/renderit/users/auth_user.html', '/renderit/auth_user.html', '/renderit/default.html'] Site New in version 1.2 We can group templates by the current site. This option can be supplied via the template tag as site=true or enabled globally using the SITE_GROUPS setting. {% renderit auth.user with site=true %} Generated List: ['/renderit/1/auth_user.html', '/renderit/auth_user.html', '/renderit/default.html'] The example above will automatically apply the site id as part of the group Arguments Example 17

22 Note: While this looks like just another group i.e. 1/a/b, it acts slightly different when the site is reached. Normally when the last group is reached, in this case 1 the template generator would just remove the 1 and try any prefix and arg combination left, but the site functionality will remove the 1 and then try all the normal groups (anything other than the site) all over again. Here is an example without sites:.. code-bloack:: django {% renderit test with groups=1/a/b %} Generated List: ['renderit/1/a/b/test.html', 'renderit/1/a/test.html', 'renderit/1/test.html', 'renderit/test.html', 'renderit/default.html'] Here is an example with sites (notice the removal of 1 in the groups):.. code-bloack:: django {% renderit test with groups=a/b sites=true %} Generated List: ['renderit/1/a/b/test.html', 'renderit/1/a/test.html', 'renderit/1/test.html', 'renderit/a/b/test.html', 'renderit/a/test.html', 'renderit/testhtml', 'renderit/default.html'] As shown, the site id is used first, but when the site id is removed, it will reset the groups with no site id. This gives us the ability to have defaults and site overrides. Site value generation The above examples showed the default value used, the pk of the site, but this isn t very developer friendly. When site ability is enabled we can specify a custom site value function which should yield a string. The default is renderit.templatetags.renderit_tags.default_get_site_func Change the setting SITE_GET_FUNC to a custom function to return something more friendly. For example: 18 Chapter 4. Template Fallback

23 RENDERIT_SETTINGS = { 'SITE_GET_FUNC': 'example.sample_app.utils.get_site_name' } def get_site_name(): site_map = { 1: 'white', 2: 'black', 3: 'red', 4: 'blue' } return site_map.get(site.objects.get_current().pk) Combined The list of generated template paths can get rather large when using multiple arguments, a prefix and a group together {% renderit auth.user hompage custom with prefix=logininfo group=users %} Generated List: ['/renderit/users/logininfo_auth_user_admins_custom.html', '/renderit/users/logininfo_auth_user_admin.html', '/renderit/users/logininfo_auth_user.html', '/renderit/users/logininfo_auth_user_admin_custom.html', '/renderit/users/logininfo_auth_user_homepage.html', '/renderit/users/auth_user.html', '/renderit/logininfo_auth_user_homepage_custom.html', '/renderit/logininfo_auth_user_homepage.html', '/renderit/logininfo_auth_user.html', '/renderit/auth_user_homepage_custom.html', '/renderit/auth_user_homepage.html', '/renderit/auth_user.html', '/renderit/default.html'] What we have here is 2 sets with 2 inner sets of templates, one set has the group users one without, the inner set has one set with prefix logininfo and one set without. Note: This is just the generated template path list, these templates do not have to exist, this is simply a way to fallback to other templates in case a template does not exist. With the update to group argument to allow a path, the generate list gets even larger. {% renderit auth.user admins custom with prefix=logininfo group=users/homepage %} Generated List: ['/renderit/users/homepage/logininfo_auth_user_admins_custom.html', '/renderit/users/homepage/logininfo_auth_user_admins.html', '/renderit/users/homepage/logininfo_auth_user.html', 4.2. Arguments Example 19

24 '/renderit/users/homepage/auth_user_admins_custom.html', '/renderit/users/homepage/auth_user_admins.html', '/renderit/users/homepage/auth_user.html', '/renderit/users/logininfo_auth_user_admins_custom.html', '/renderit/users/logininfo_auth_user_admins.html', '/renderit/users/logininfo_auth_user.html', '/renderit/users/auth_user_admins_custom.html', '/renderit/users/auth_user_admins.html', '/renderit/users/auth_user.html', '/renderit/logininfo_auth_user_admins_custom.html', '/renderit/logininfo_auth_user_admins.html', '/renderit/logininfo_auth_user.html', '/renderit/auth_user_admins_custom.html', '/renderit/auth_user_admins.html', '/renderit/auth_user.html', '/renderit/default.html'] This is similar to the previous example, except that now we have users/homepage as one set and users as another set 4.3 The other arguments concat This argumennt is taken literally and will not create any extra sets. If we take the last example and add concatination string to be (double underscore) we would get: {% renderit auth.user hompage custom with prefix=logininfo group=users concat=" " %} Generated List: ['/renderit/users/logininfo auth user homepage custom.html', '/renderit/users/logininfo auth user homepage.html', '/renderit/users/logininfo auth user.html', '/renderit/users/auth user homepage custom.html', '/renderit/users/auth user homepage.html', '/renderit/users/auth user.html', '/renderit/logininfo auth user homepage custom.html', '/renderit/logininfo auth user homepage.html', '/renderit/logininfo auth user.html', '/renderit/auth user homepage custom.html', '/renderit/auth user homepage.html', '/renderit/auth user.html', '/renderit/default.html'] 20 Chapter 4. Template Fallback

25 CHAPTER 5 Settings All settings are grouped in the RENDERIT_SETTINGS dictionary, below are all the possible options Note: You can also use individual settings by prepending RENDERIT_ in front of the names below. If you combine both, the individual settings will act as defaults, and the dictionary will override the setting if supplied 5.1 CONCATINATION_STRING Change the default concatination strings, default is _ (underscore) 5.2 ROOT_TEMPLATE_PATH Change the default root template path to look for the templates, default is /renderit/ 5.3 DEBUG Outputs some debugging information to the console, defaults to the value of DEBUG 5.4 SITE_GROUPS Boolean value indicated if renderit should care about sites 21

26 5.5 SITE_GET_FUNC By default when site groups are enabled, it will use the pk of the site. However if we want cleaner names, you can define your own function to get the value. Defaults to renderit.templatetags.renderit_tags.default_get_site_func 22 Chapter 5. Settings

27 CHAPTER 6 Contributing Source Issues 23

28 24 Chapter 6. Contributing

29 CHAPTER 7 Indices and tables genindex modindex search 25

MIT AITI Python Software Development Lab DJ1:

MIT AITI Python Software Development Lab DJ1: MIT AITI Python Software Development Lab DJ1: This lab will help you get Django installed and write your first application. 1 Each person in your group must complete this lab and have it checked off. Make

More information

django-avatar Documentation

django-avatar Documentation django-avatar Documentation Release 2.0 django-avatar developers Oct 04, 2018 Contents 1 Installation 3 2 Usage 5 3 Template tags and filter 7 4 Global Settings 9 5 Management Commands 11 i ii django-avatar

More information

django-avatar Documentation

django-avatar Documentation django-avatar Documentation Release 2.0 django-avatar developers Sep 27, 2017 Contents 1 Installation 3 2 Usage 5 3 Template tags and filter 7 4 Global Settings 9 5 Management Commands 11 i ii django-avatar

More information

alphafilter Documentation

alphafilter Documentation alphafilter Documentation Release 0.6 coordt September 09, 2013 CONTENTS i ii alphafilter Documentation, Release 0.6 Contents: CONTENTS 1 alphafilter Documentation, Release 0.6 2 CONTENTS CHAPTER ONE

More information

Bricks Documentation. Release 1.0. Germano Guerrini

Bricks Documentation. Release 1.0. Germano Guerrini Bricks Documentation Release 1.0 Germano Guerrini January 27, 2015 Contents 1 Requirements 3 2 Contents 5 2.1 Getting Started.............................................. 5 2.2 Basic Usage...............................................

More information

django-slim Documentation

django-slim Documentation django-slim Documentation Release 0.5 Artur Barseghyan December 24, 2013 Contents i ii django-slim Contents 1 2 Contents CHAPTER 1 Description Simple implementation of multi-lingual

More information

Django-Select2 Documentation. Nirupam Biswas

Django-Select2 Documentation. Nirupam Biswas Nirupam Biswas Mar 07, 2018 Contents 1 Get Started 3 1.1 Overview................................................. 3 1.2 Installation................................................ 3 1.3 External Dependencies..........................................

More information

Django urls Django Girls Tutorial

Django urls Django Girls Tutorial Django urls Django Girls Tutorial about:reader?url=https://tutorial.djangogirls.org/en/django_urls/ 1 di 6 13/11/2017, 20:01 tutorial.djangogirls.org Django urls Django Girls Tutorial DjangoGirls 6-8 minuti

More information

django-precise-bbcode Documentation

django-precise-bbcode Documentation django-precise-bbcode Documentation Release 1.0.x Morgan Aubert Aug 12, 2018 Contents 1 Features 3 2 Using django-precise-bbcode 5 2.1 Getting started.............................................. 5 2.2

More information

django-intercom Documentation

django-intercom Documentation django-intercom Documentation Release 0.0.12 Ken Cochrane February 01, 2016 Contents 1 Installation 3 2 Usage 5 3 Enable Secure Mode 7 4 Intercom Inbox 9 5 Custom Data 11 6 Settings 13 6.1 INTERCOM_APPID...........................................

More information

django-cms-search Documentation

django-cms-search Documentation django-cms-search Documentation Release 0.6.2 Divio GmbH February 04, 2016 Contents 1 Requirements 3 2 Usage 5 2.1 Customizing the Index.......................................... 5 3 Helpers 7 3.1 {%

More information

Django Admin Sortable Documentation

Django Admin Sortable Documentation Django Admin Sortable Documentation Release 1.7.0 Brandon Taylor September 28, 2016 Contents 1 Supported Django Versions 3 1.1 Django 1.4.x............................................... 3 1.2 Django

More information

django-generic-aggregation Documentation

django-generic-aggregation Documentation django-generic-aggregation Documentation Release 0.4.0 charles leifer September 20, 2016 Contents 1 installation 3 2 examples 5 3 important detail 7 4 api 9 4.1 Indices and tables............................................

More information

Django Extra Views Documentation

Django Extra Views Documentation Django Extra Views Documentation Release 0.12.0 Andrew Ingram Nov 30, 2018 Contents 1 Features 3 2 Table of Contents 5 2.1 Getting Started.............................................. 5 2.2 Formset Views..............................................

More information

TailorDev Contact Documentation

TailorDev Contact Documentation TailorDev Contact Documentation Release 0.3 Julien Maupetit November 06, 2013 Contents 1 Django TailorDev Contact 3 1.1 Dependencies............................................... 3 1.2 Installation................................................

More information

Django-CSP Documentation

Django-CSP Documentation Django-CSP Documentation Release 3.0 James Socol, Mozilla September 06, 2016 Contents 1 Installing django-csp 3 2 Configuring django-csp 5 2.1 Policy Settings..............................................

More information

Django QR Code Documentation

Django QR Code Documentation Django QR Code Documentation Release 0.3.3 Philippe Docourt Nov 12, 2017 Contents: 1 Django QR Code 1 1.1 Installation................................................ 1 1.2 Usage...................................................

More information

wagtailmenus Documentation

wagtailmenus Documentation wagtailmenus Documentation Release 2.12 Andy Babic Nov 17, 2018 Contents 1 Full index 3 1.1 Overview and key concepts....................................... 3 1.1.1 Better control over top-level menu

More information

Django File Picker Documentation

Django File Picker Documentation Django File Picker Documentation Release 0.5 Caktus Consulting Group LLC Nov 06, 2017 Contents 1 Dependencies 3 1.1 Required................................................. 3 1.2 Optional.................................................

More information

kaleo Documentation Release 1.5 Eldarion

kaleo Documentation Release 1.5 Eldarion kaleo Documentation Release 1.5 Eldarion October 06, 2014 Contents 1 Development 3 1.1 Contents................................................. 3 i ii Provides a site with user to user invitations, working

More information

CSE 115. Introduction to Computer Science I

CSE 115. Introduction to Computer Science I CSE 115 Introduction to Computer Science I Road map Review Limitations of front-end sites Web servers Examples Review

More information

django-subdomains Documentation

django-subdomains Documentation django-subdomains Documentation Release 2.1.0 ted kaemming April 29, 2016 Contents 1 Installation 3 2 Quick Start 5 2.1 Example Configuration.......................................... 5 3 Basic Usage

More information

django-conduit Documentation

django-conduit Documentation django-conduit Documentation Release 0.0.1 Alec Koumjian Apr 24, 2017 Contents 1 Why Use Django-Conduit? 3 2 Table of Contents 5 2.1 Filtering and Ordering.......................................... 5

More information

Django. Jinja2. Aymeric Augustin DjangoCong 2016

Django. Jinja2. Aymeric Augustin DjangoCong 2016 Django Jinja2 Aymeric Augustin DjangoCong 2016 Jardin des Plantes, Avranches, 9 avril 2016 I m Aymeric Amalfi Core Developer since 2011 Chief Technical Officer since 2015 Time zones Python 3 Transactions

More information

Django-frontend-notification Documentation

Django-frontend-notification Documentation Django-frontend-notification Documentation Release 0.2.0 Arezqui Belaid February 25, 2016 Contents 1 Introduction 3 1.1 Overview................................................. 3 1.2 Documentation..............................................

More information

Django File Picker Documentation

Django File Picker Documentation Django File Picker Documentation Release 0.5 Caktus Consulting Group LLC Oct 31, 2017 Contents 1 Dependencies 3 1.1 Required................................................. 3 1.2 Optional.................................................

More information

micawber Documentation

micawber Documentation micawber Documentation Release 0.3.4 charles leifer Nov 29, 2017 Contents 1 examples 3 2 integration with web frameworks 5 2.1 Installation................................................ 5 2.2 Getting

More information

Bambu API Documentation

Bambu API Documentation Bambu API Documentation Release 2.0.1 Steadman Sep 27, 2017 Contents 1 About Bambu API 3 2 About Bambu Tools 2.0 5 3 Installation 7 4 Basic usage 9 5 Questions or suggestions? 11 6 Contents 13 6.1 Defining

More information

ejpiaj Documentation Release Marek Wywiał

ejpiaj Documentation Release Marek Wywiał ejpiaj Documentation Release 0.4.0 Marek Wywiał Mar 06, 2018 Contents 1 ejpiaj 3 1.1 License.................................................. 3 1.2 Features..................................................

More information

Quick housekeeping Last Two Homeworks Extra Credit for demoing project prototypes Reminder about Project Deadlines/specifics Class on April 12th Resul

Quick housekeeping Last Two Homeworks Extra Credit for demoing project prototypes Reminder about Project Deadlines/specifics Class on April 12th Resul CIS192 Python Programming Web Frameworks and Web APIs Harry Smith University of Pennsylvania March 29, 2016 Harry Smith (University of Pennsylvania) CIS 192 March 29, 2016 1 / 25 Quick housekeeping Last

More information

Client Side JavaScript and AJAX

Client Side JavaScript and AJAX Client Side JavaScript and AJAX Client side javascript is JavaScript that runs in the browsers of people using your site. So far all the JavaScript code we've written runs on our node.js server. This is

More information

Python Schema Generator Documentation

Python Schema Generator Documentation Python Schema Generator Documentation Release 1.0.0 Peter Demin June 26, 2016 Contents 1 Mutant - Python code generator 3 1.1 Project Status............................................... 3 1.2 Design..................................................

More information

django-embed-video Documentation

django-embed-video Documentation django-embed-video Documentation Release 0.7.stable Juda Kaleta December 21, 2013 Contents i ii Django app for easy embeding YouTube and Vimeo videos and music from SoundCloud. Repository is located on

More information

django-model-report Documentation

django-model-report Documentation django-model-report Documentation Release 0.2.1 juanpex Nov 06, 2017 Contents 1 Demo 3 1.1 User Guide................................................ 3 1.2 Modules.................................................

More information

Django Groups Manager Documentation

Django Groups Manager Documentation Django Groups Manager Documentation Release 0.3.0 Vittorio Zamboni May 03, 2017 Contents 1 Documentation 3 1.1 Installation................................................ 3 1.2 Basic usage................................................

More information

wagtailmenus Documentation

wagtailmenus Documentation wagtailmenus Documentation Release 2.11 Andy Babic Aug 02, 2018 Contents 1 Full index 3 1.1 Overview and key concepts....................................... 3 1.1.1 Better control over top-level menu

More information

django-embed-video Documentation

django-embed-video Documentation django-embed-video Documentation Release 0.6.stable Juda Kaleta October 04, 2013 CONTENTS i ii Django app for easy embeding YouTube and Vimeo videos and music from SoundCloud. Repository is located on

More information

Django PAM Documentation

Django PAM Documentation Django PAM Documentation Release 1.4.1 Carl J. Nobile Aug 01, 2018 Contents 1 Contents 3 1.1 Installation................................................ 3 1.2 Configuration...............................................

More information

django-ad-code Documentation

django-ad-code Documentation django-ad-code Documentation Release 1.0.0 Mark Lavin Apr 21, 2018 Contents 1 Installation 3 2 Documentation 5 3 License 7 4 Contributing 9 5 Contents 11 5.1 Getting Started..............................................

More information

django-openid Documentation

django-openid Documentation django-openid Documentation Release 2.0a Simon Willison September 27, 2017 Contents 1 Installation 3 2 Accepting OpenID 5 2.1 Redirecting somewhere else....................................... 6 2.2 Requesting

More information

termite Release 0.0.2

termite Release 0.0.2 termite Release 0.0.2 February 16, 2017 Contents 1 Features 3 2 Alternatives 5 3 Why another build tool? 7 4 Requeriments 9 5 Installation 11 5.1 Basic concepts..............................................

More information

django-notifier Documentation

django-notifier Documentation django-notifier Documentation Release 0.7 Siddharth Doshi August 19, 2014 Contents 1 Dependecies 3 2 Contents 5 2.1 Installation & Setup........................................... 5 2.2 Quickstart................................................

More information

colab Documentation Release 2.0dev Sergio Oliveira

colab Documentation Release 2.0dev Sergio Oliveira colab Documentation Release 2.0dev Sergio Oliveira Sep 27, 2017 Contents 1 User Documentation 3 1.1 Getting Started.............................................. 3 1.2 Widgets..................................................

More information

Easy-select2 Documentation

Easy-select2 Documentation Easy-select2 Documentation Release 1.2.2 Lobanov Stanislav aka asyncee September 15, 2014 Contents 1 Installation 3 2 Quickstart 5 3 Configuration 7 4 Usage 9 5 Reference 11 5.1 Widgets..................................................

More information

django-amp-tools Documentation Release latest

django-amp-tools Documentation Release latest django-amp-tools Documentation Release latest February 07, 2017 Contents 1 Installation 3 2 Usage 5 2.1 Usage app................................................ 5 3 Contributing 9 4 Source code and contacts

More information

django-gollum Documentation

django-gollum Documentation django-gollum Documentation Release 1.0.0 Luke Sneeringer December 11, 2016 Contents 1 Installation 3 2 Dependencies 5 3 Getting Started 7 4 Getting Help 9 5 License 11 6 Index 13 6.1 Using django-gollum...........................................

More information

django-baton Documentation

django-baton Documentation django-baton Documentation Release 1.0.7 abidibo Nov 13, 2017 Contents 1 Features 3 2 Getting started 5 2.1 Installation................................................ 5 2.2 Configuration...............................................

More information

Django: Views, Templates, and Sessions

Django: Views, Templates, and Sessions Django: Views, Templates, and Sessions CS 370 SE Practicum, Cengiz Günay (Some slides courtesy of Eugene Agichtein and the Internets) CS 370, Günay (Emory) Django Views/Templates Spring 2014 1 / 7 Agenda

More information

django-fluent-dashboard Documentation

django-fluent-dashboard Documentation django-fluent-dashboard Documentation Release 1.0a1 Diederik van der Boor June 16, 2016 Contents 1 Installation 3 1.1 Django configuration........................................... 3 2 Configuration

More information

Django Groups Manager Documentation

Django Groups Manager Documentation Django Groups Manager Documentation Release 0.3.0 Vittorio Zamboni January 03, 2017 Contents 1 Documentation 3 1.1 Installation................................................ 3 1.2 Basic usage................................................

More information

django-messages Documentation

django-messages Documentation django-messages Documentation Release 0.5.0 Arne Brodowski Nov 18, 2017 Contents 1 Contents 3 1.1 Installing django-messages........................................ 3 1.2 Using django-messages.........................................

More information

Gargoyle Documentation

Gargoyle Documentation Gargoyle Documentation Release 0.11.0 DISQUS Aug 27, 2017 Contents 1 Installation 3 1.1 Enable Gargoyle............................................. 3 1.2 Nexus Frontend.............................................

More information

Django Forme Documentation

Django Forme Documentation Django Forme Documentation Release 0.1.dev Tomáš Ehrlich Sep 27, 2017 Contents 1 Tutorial 3 1.1 Getting started.............................................. 3 1.2 Basic example..............................................

More information

django-xross Documentation

django-xross Documentation django-xross Documentation Release 0.6.0 Igor idle sign Starikov Jan 14, 2018 Contents 1 Description 3 2 Requirements 5 3 Table of Contents 7 3.1 Quickstart................................................

More information

django-cron Documentation

django-cron Documentation django-cron Documentation Release 0.3.5 Tivix Inc. Mar 04, 2017 Contents 1 Introduction 3 2 Installation 5 3 Configuration 7 4 Sample Cron Configurations 9 4.1 Retry after failure feature........................................

More information

django-embed-video Documentation

django-embed-video Documentation django-embed-video Documentation Release 1.1.2-stable Juda Kaleta Nov 10, 2017 Contents 1 Installation & Setup 3 1.1 Installation................................................ 3 1.2 Setup...................................................

More information

Release Joris Beckers

Release Joris Beckers django a uth a dfsdocumentation Release 0.2.0 Joris Beckers Sep 14, 2017 Contents 1 Features 3 2 Contents 5 2.1 Installation................................................ 5 2.1.1 Requirements..........................................

More information

django-oauth2-provider Documentation

django-oauth2-provider Documentation django-oauth2-provider Documentation Release 0.2.7-dev Alen Mujezinovic Aug 16, 2017 Contents 1 Getting started 3 1.1 Getting started.............................................. 3 2 API 5 2.1 provider.................................................

More information

wagtailtrans Documentation

wagtailtrans Documentation wagtailtrans Documentation Release 0.1.0 LUKKIEN Jul 27, 2018 Contents 1 Table of contents 3 1.1 Getting started.............................................. 3 1.2 Migrate your existing Wagtail site....................................

More information

tally Documentation Release Dan Watson

tally Documentation Release Dan Watson tally Documentation Release 1.0.0 Dan Watson Sep 27, 2017 Contents 1 Installation 3 1.1 The tally Server............................................. 3 1.2 Sending Metrics.............................................

More information

django-report-tools Documentation

django-report-tools Documentation django-report-tools Documentation Release 0.2.1 Evan Brumley Jul 20, 2017 Contents 1 Contents 3 1.1 Getting Started.............................................. 3 1.2 Charts...................................................

More information

django-dajax Documentation

django-dajax Documentation django-dajax Documentation Release 0.9 Jorge Bastida Nov 16, 2017 Contents 1 Documentation 3 1.1 Installation................................................ 3 1.2 API....................................................

More information

Socrates Documentation

Socrates Documentation Socrates Documentation Release 0.6.0 Honza Pokorny July 23, 2011 CONTENTS i ii Socrates is a simple static site generator. It s geared towards blogs. You write your posts in your favorite plain text to

More information

django simple pagination Documentation

django simple pagination Documentation django simple pagination Documentation Release 1.1.5 Micro Pyramid Nov 08, 2017 Contents 1 Getting started 3 1.1 Requirements............................................... 3 1.2 Installation................................................

More information

django-audit-log Documentation

django-audit-log Documentation django-audit-log Documentation Release 0.8.0 Vasil Vangelovski (Atomidata) Jul 21, 2017 Contents 1 Installation 3 2 Tracking Users that Created/Modified a Model 5 2.1 Tracking Who Created a Model.....................................

More information

CIS192 Python Programming

CIS192 Python Programming CIS192 Python Programming Web Servers and Web APIs Raymond Yin University of Pennsylvania November 12, 2015 Raymond Yin (University of Pennsylvania) CIS 192 November 12, 2015 1 / 23 Outline 1 Web Servers

More information

django-baton Documentation

django-baton Documentation django-baton Documentation Release 1.3.1 abidibo Nov 05, 2018 Contents 1 Features 3 2 Getting started 5 2.1 Installation................................................ 5 2.2 Configuration...............................................

More information

django-oscar-paypal Documentation

django-oscar-paypal Documentation django-oscar-paypal Documentation Release 1.0.0 David Winterbottom May 30, 2018 Contents 1 Installation 3 2 Table of contents 5 2.1 Express checkout............................................. 5 2.2

More information

django-password-reset Documentation

django-password-reset Documentation django-password-reset Documentation Release 1.0 Bruno Renié Sep 21, 2017 Contents 1 Quickstart 3 1.1 Installation................................................ 3 1.2 Usage...................................................

More information

fragapy Documentation

fragapy Documentation fragapy Documentation Release 1.0 2011, Fragaria, s.r.o November 09, 2011 CONTENTS 1 Adminhelp 3 2 Amazon 5 2.1 AWS branded scripts........................................... 5 2.2 SES SMTP relay.............................................

More information

django-revproxy Documentation

django-revproxy Documentation django-revproxy Documentation Release 0.9.14 Sergio Oliveira Jun 30, 2017 Contents 1 Features 3 2 Dependencies 5 3 Install 7 4 Contents: 9 4.1 Introduction...............................................

More information

LECTURE 14. Web Frameworks

LECTURE 14. Web Frameworks LECTURE 14 Web Frameworks WEB DEVELOPMENT CONTINUED Web frameworks are collections of packages or modules which allow developers to write web applications with minimal attention paid to low-level details

More information

Theming with Twig in Drupal 8. John Jennings Developer, Johnson & Johnson

Theming with Twig in Drupal 8. John Jennings Developer, Johnson & Johnson Theming with Twig in Drupal 8 John Jennings Developer, Johnson & Johnson What is Twig? From SensioLabs, the developers about Twig: A templating engine for PHP, thus requiring PHP (v. 5.3.3 minimum) Compiles

More information

Django Leaflet Documentation

Django Leaflet Documentation Django Leaflet Documentation Release 0.20 Makina Corpus Oct 04, 2017 Contents 1 Installation 3 1.1 Configuration............................................... 3 1.2 Example.................................................

More information

canary Documentation Release 0.1 Branton K. Davis

canary Documentation Release 0.1 Branton K. Davis canary Documentation Release 0.1 Branton K. Davis August 18, 2012 CONTENTS 1 Installation 3 1.1 Installing Canary Reports........................................ 3 1.2 Running the Demo Project........................................

More information

Django Test Utils Documentation

Django Test Utils Documentation Django Test Utils Documentation Release 0.3 Eric Holscher July 22, 2016 Contents 1 Source Code 3 2 Contents 5 2.1 Django Testmaker............................................ 5 2.2 Django Crawler.............................................

More information

Django CBTools Documentation

Django CBTools Documentation Django CBTools Documentation Release 1.2.0 Viacheslav Iutin August 05, 2016 Contents 1 Installation 3 1.1 Pre-requisite............................................... 3 1.2 Requirements...............................................

More information

django-image-cropping Documentation

django-image-cropping Documentation django-image-cropping Documentation Release 1.1.0 Jonas und der Wolf Nov 06, 2017 Contents 1 Installation 3 2 Configuration 5 3 Admin Integration 7 4 Backends 9 5 Frontend 11 5.1 easy_thumbnails.............................................

More information

.. Documentation. Release 0.4 beta. Author

.. Documentation. Release 0.4 beta. Author .. Documentation Release 0.4 beta Author May 06, 2015 Contents 1 Browser 3 1.1 Basic usages............................................... 3 1.2 Form manipulation............................................

More information

mincss Documentation Release 0.1 Peter Bengtsson

mincss Documentation Release 0.1 Peter Bengtsson mincss Documentation Release 0.1 Peter Bengtsson Sep 27, 2017 Contents 1 Getting started 3 2 Supported Features and Limitations 5 3 API 7 4 Changelog 9 4.1 v0.8.1 (2013-04-05)...........................................

More information

nacelle Documentation

nacelle Documentation nacelle Documentation Release 0.4.1 Patrick Carey August 16, 2014 Contents 1 Standing on the shoulders of giants 3 2 Contents 5 2.1 Getting Started.............................................. 5 2.2

More information

django-autocomplete-light Documentation

django-autocomplete-light Documentation django-autocomplete-light Documentation Release 3.0.4 James Pic & contributors March 08, 2016 Contents 1 Features 1 2 Resources 3 3 Basics 5 3.1 Install django-autocomplete-light v3...................................

More information

I hate money. Release 1.0

I hate money. Release 1.0 I hate money Release 1.0 Nov 01, 2017 Contents 1 Table of content 3 2 Indices and tables 15 i ii «I hate money» is a web application made to ease shared budget management. It keeps track of who bought

More information

Django Image Tools Documentation

Django Image Tools Documentation Django Image Tools Documentation Release 0.7.b1 Bonsai Studio May 05, 2017 Contents 1 Quick Start 3 1.1 Configuration............................................... 3 1.2 Example models.............................................

More information

Kiki Documentation. Release 0.7a1. Stephen Burrows

Kiki Documentation. Release 0.7a1. Stephen Burrows Kiki Documentation Release 0.7a1 Stephen Burrows August 14, 2013 CONTENTS i ii Kiki Documentation, Release 0.7a1 Kiki is envisioned as a Django-based mailing list manager which can replace Mailman. CONTENTS

More information

django-reinhardt Documentation

django-reinhardt Documentation django-reinhardt Documentation Release 0.1.0 Hyuntak Joo December 02, 2016 Contents 1 django-reinhardt 3 1.1 Installation................................................ 3 1.2 Usage...................................................

More information

web.xml Deployment Descriptor Elements

web.xml Deployment Descriptor Elements APPENDIX A web.xml Deployment Descriptor s The following sections describe the deployment descriptor elements defined in the web.xml schema under the root element . With Java EE annotations, the

More information

web.py Tutorial Tom Kelliher, CS 317 This tutorial is the tutorial from the web.py web site, with a few revisions for our local environment.

web.py Tutorial Tom Kelliher, CS 317 This tutorial is the tutorial from the web.py web site, with a few revisions for our local environment. web.py Tutorial Tom Kelliher, CS 317 1 Acknowledgment This tutorial is the tutorial from the web.py web site, with a few revisions for our local environment. 2 Starting So you know Python and want to make

More information

django-selenium Documentation

django-selenium Documentation django-selenium Documentation Release 0.9.5 Roman Prokofyev Sep 27, 2017 Contents 1 Django 1.4 note 3 2 What is it? 5 3 Dependencies 7 4 How to use it 9 4.1 Local...................................................

More information

Django IPRestrict Documentation

Django IPRestrict Documentation Django IPRestrict Documentation Release 1.4.1 Tamas Szabo Nov 06, 2017 Contents 1 Table of Contents 3 1.1 Requirements and Installation...................................... 3 1.2 Configuration...............................................

More information

staff Documentation Release 1.2

staff Documentation Release 1.2 staff Documentation Release 1.2 me February 06, 2016 Contents 1 Goals 3 2 Contents 5 2.1 Getting Started.............................................. 5 2.2 Customizing StaffMember........................................

More information

django-facebook-graph Documentation

django-facebook-graph Documentation django-facebook-graph Documentation Release 0.1 FEINHEIT GmbH Mar 29, 2017 Contents 1 Installation 3 1.1 Add 'facebook' to your INSTALLED_APPS............................ 3 1.2 Add the middlewares...........................................

More information

django-sticky-uploads Documentation

django-sticky-uploads Documentation django-sticky-uploads Documentation Release 0.2.0 Caktus Consulting Group October 26, 2014 Contents 1 Requirements/Installing 3 2 Browser Support 5 3 Documentation 7 4 Running the Tests 9 5 License 11

More information

LECTURE 14. Web Frameworks

LECTURE 14. Web Frameworks LECTURE 14 Web Frameworks WEB DEVELOPMENT CONTINUED Web frameworks are collections of packages or modules which allow developers to write web applications with minimal attention paid to low-level details

More information

xmljson Documentation

xmljson Documentation xmljson Documentation Release 0.1.9 S Anand Aug 01, 2017 Contents 1 About 3 2 Convert data to XML 5 3 Convert XML to data 7 4 Conventions 9 5 Options 11 6 Installation 13 7 Roadmap 15 8 More information

More information

Django_template3d Documentation

Django_template3d Documentation Django_template3d Documentation Release 0.0.1 Robert Steckroth August 27, 2016 Contents 1 Getting Started 3 1.1 Quick Install............................................... 3 2 Learning Template3d 5 2.1

More information

Graphene Documentation

Graphene Documentation Graphene Documentation Release 1.0.dev Syrus Akbary Nov 09, 2017 Contents 1 Introduction tutorial - Graphene and Django 3 1.1 Set up the Django project........................................ 3 1.2 Hello

More information

HOW TO FLASK. And a very short intro to web development and databases

HOW TO FLASK. And a very short intro to web development and databases HOW TO FLASK And a very short intro to web development and databases FLASK Flask is a web application framework written in Python. Created by an international Python community called Pocco. Based on 2

More information

The simple but powerful elegance of Django REST Framework. start

The simple but powerful elegance of Django REST Framework. start The simple but powerful elegance of Django REST Framework start Morten Barklund Full-stack Freelancer Rookie Pythonista Decent Djangoneer 2 Table of Contents 01 Django REST Framework 02 Permissions 03

More information

django-allauth-2fa Documentation

django-allauth-2fa Documentation django-allauth-2fa Documentation Release 0.4.3 Víðir Valberg Guðmundsson, Percipient Networks Apr 25, 2018 Contents: 1 Features 3 2 Compatibility 5 3 Contributing 7 3.1 Running tests...............................................

More information