add_tools.md

Adding Tools

• Create a template for tool under templates/tools/ with following format

{% extends "tools/tool_base.html" %}
{% load staticfiles %}

{% block tool %}
{% endblock %}

{% block scripts %}
{% endblock %}

• Login to Admin Panel and add tool, fill in author, template name, url_endpoint and other info regarding the tool.

• For client side tool, the logic for the tool has to be written in javascript in the template itself. Below is an example:

    function capitalize() {
      var text = $('#inputtextarea').val().toUpperCase();
      $('#outputtextarea').val(text);
    }
  

• For server side tool, create a new view and register url for the same. The logic for the tool will be in the views.py file.

  # tool_views.py
  def convert_file(request):
      #logic here
  
    return response
  
  # urls.py
  urlpatterns = [
   ...
   url(r'^convert_file/$',
          views.convert_file,
          name='convert_file'),
   ...
    ]
  

Conventions to be followed

Follow the conventions as stated in PEP8, apart the following conventions should be followed.

• Templates: A template for tool should be added to tools/<category>/ under templates folder. The template name should be meaningful, in lowercase and use '_' instead of space. Examples: prettify_css.html, lowercase.html.
  For a tool name Code Editor the template name should be code_editor.html

• Views:

  • function based view

     def jpg_to_png_converter():
    //code
    

  • class based view

      class UserProfileView():
          //code
    

• URLs: The generic url for tools is /t/<url_endpoint>, where url_endpoint is defined by user while adding tool to database.