diff options
Diffstat (limited to 'nikola/plugins/compile/rest/chart.py')
| -rw-r--r-- | nikola/plugins/compile/rest/chart.py | 150 |
1 files changed, 150 insertions, 0 deletions
diff --git a/nikola/plugins/compile/rest/chart.py b/nikola/plugins/compile/rest/chart.py new file mode 100644 index 0000000..ee917b9 --- /dev/null +++ b/nikola/plugins/compile/rest/chart.py @@ -0,0 +1,150 @@ +# -*- coding: utf-8 -*- + +# Copyright © 2012-2013 Roberto Alsina and others. + +# 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. + +from ast import literal_eval + +from docutils import nodes +from docutils.parsers.rst import Directive, directives + +try: + import pygal +except ImportError: + pygal = None # NOQA + +from nikola.plugin_categories import RestExtension +from nikola.utils import req_missing + + +class Plugin(RestExtension): + + name = "rest_chart" + + def set_site(self, site): + self.site = site + directives.register_directive('chart', Chart) + return super(Plugin, self).set_site(site) + + +class Chart(Directive): + """ Restructured text extension for inserting charts as SVG + + Usage: + .. chart:: Bar + :title: 'Browser usage evolution (in %)' + :x_labels: ["2002", "2003", "2004", "2005", "2006", "2007"] + + 'Firefox', [None, None, 0, 16.6, 25, 31] + 'Chrome', [None, None, None, None, None, None] + 'IE', [85.8, 84.6, 84.7, 74.5, 66, 58.6] + 'Others', [14.2, 15.4, 15.3, 8.9, 9, 10.4] + """ + + has_content = True + required_arguments = 1 + option_spec = { + "copy": directives.unchanged, + "css": directives.unchanged, + "disable_xml_declaration": directives.unchanged, + "dots_size": directives.unchanged, + "explicit_size": directives.unchanged, + "fill": directives.unchanged, + "font_sizes": directives.unchanged, + "height": directives.unchanged, + "human_readable": directives.unchanged, + "include_x_axis": directives.unchanged, + "interpolate": directives.unchanged, + "interpolation_parameters": directives.unchanged, + "interpolation_precision": directives.unchanged, + "js": directives.unchanged, + "label_font_size": directives.unchanged, + "legend_at_bottom": directives.unchanged, + "legend_box_size": directives.unchanged, + "legend_font_size": directives.unchanged, + "logarithmic": directives.unchanged, + "major_label_font_size": directives.unchanged, + "margin": directives.unchanged, + "no_data_font_size": directives.unchanged, + "no_data_text": directives.unchanged, + "no_prefix": directives.unchanged, + "order_min": directives.unchanged, + "pretty_print": directives.unchanged, + "print_values": directives.unchanged, + "print_zeroes": directives.unchanged, + "range": directives.unchanged, + "rounded_bars": directives.unchanged, + "show_dots": directives.unchanged, + "show_legend": directives.unchanged, + "show_minor_x_labels": directives.unchanged, + "show_y_labels": directives.unchanged, + "spacing": directives.unchanged, + "strict": directives.unchanged, + "stroke": directives.unchanged, + "style": directives.unchanged, + "title": directives.unchanged, + "title_font_size": directives.unchanged, + "to_dict": directives.unchanged, + "tooltip_border_radius": directives.unchanged, + "tooltip_font_size": directives.unchanged, + "truncate_label": directives.unchanged, + "truncate_legend": directives.unchanged, + "value_font_size": directives.unchanged, + "value_formatter": directives.unchanged, + "width": directives.unchanged, + "x_label_rotation": directives.unchanged, + "x_labels": directives.unchanged, + "x_labels_major": directives.unchanged, + "x_labels_major_count": directives.unchanged, + "x_labels_major_every": directives.unchanged, + "x_title": directives.unchanged, + "y_label_rotation": directives.unchanged, + "y_labels": directives.unchanged, + "y_title": directives.unchanged, + "zero": directives.unchanged, + } + + def run(self): + if pygal is None: + msg = req_missing(['pygal'], 'use the Chart directive', optional=True) + return [nodes.raw('', '<div class="text-error">{0}</div>'.format(msg), format='html')] + options = {} + if 'style' in self.options: + style_name = self.options.pop('style') + else: + style_name = 'BlueStyle' + if '(' in style_name: # Parametric style + style = eval('pygal.style.' + style_name) + else: + style = getattr(pygal.style, style_name) + for k, v in self.options.items(): + options[k] = literal_eval(v) + + chart = getattr(pygal, self.arguments[0])(style=style) + chart.config(**options) + for line in self.content: + label, series = literal_eval('({0})'.format(line)) + chart.add(label, series) + + return [nodes.raw('', chart.render().decode('utf8'), format='html')] |