shoop.admin.dashboard package

Submodules

shoop.admin.dashboard.blocks module

class shoop.admin.dashboard.blocks.DashboardBlock(id, size=None, color=None)[source]

Bases: object

type = None
SIZES = ('small', 'medium', 'large', 'full')
default_size = 'normal'
class shoop.admin.dashboard.blocks.DashboardContentBlock(id, content, size='normal')[source]

Bases: shoop.admin.dashboard.blocks.DashboardBlock

type = 'normal'
classmethod by_rendering_template(id, request, template_name, context)[source]
class shoop.admin.dashboard.blocks.DashboardValueBlock(id, value, title, **kwargs)[source]

Bases: shoop.admin.dashboard.blocks.DashboardBlock

type = 'value'
default_size = 'small'
class shoop.admin.dashboard.blocks.DashboardNumberBlock(id, value, title, **kwargs)[source]

Bases: shoop.admin.dashboard.blocks.DashboardValueBlock

class shoop.admin.dashboard.blocks.DashboardMoneyBlock(id, value, title, currency, **kwargs)[source]

Bases: shoop.admin.dashboard.blocks.DashboardValueBlock

class shoop.admin.dashboard.blocks.DashboardChartBlock(id, size='normal')[source]

Bases: shoop.admin.dashboard.blocks.DashboardBlock

type = 'chart'
default_size = 'medium'
BLOCK_TEMPLATE = '\n <h2 class="block-title"><i class="fa fa-bar-chart"></i>%(title)s</h2>\n <div id="chart-%(id)s"></div>\n <script>\n window.CHART_CONFIGS = window.CHART_CONFIGS || {};\n window.CHART_CONFIGS["%(id)s"] = %(config)s;\n </script>\n '
get_chart()[source]

Get the actual chart instance for this block.

Returns:The chart (or None, if it can’t be rendered)
Return type:shoop.admin.dashboard.charts.Chart|None

shoop.admin.dashboard.charts module

class shoop.admin.dashboard.charts.Chart(title)[source]

Bases: object

get_config()[source]

Get a JSONable dictionary of configuration data for this chart. This is passed on as CHART_CONFIGS in the JS environment and eventually processed by dashboard-charts.js.

Returns:Dict of configuration
Return type:dict
get_config_json()[source]
class shoop.admin.dashboard.charts.BarChart(title, labels)[source]

Bases: shoop.admin.dashboard.charts.Chart

add_data(name, data)[source]
get_config()[source]

shoop.admin.dashboard.utils module

shoop.admin.dashboard.utils.get_activity(request, n_entries=30, cutoff_hours=10)[source]

Get Activity objects from all modules as a list in latest-first order.

Parameters:
  • request (django.http.request.HttpRequest) – Request context
  • n_entries (int) – Number of entries to return in total.
  • cutoff_hours (float) – Calculate cutoff datetime so the oldest entry should be at most this old
Returns:

List of Activity objects
Return type:

list[Activity]

Module contents

class shoop.admin.dashboard.BarChart(title, labels)[source]

Bases: shoop.admin.dashboard.charts.Chart

add_data(name, data)[source]
get_config()[source]
class shoop.admin.dashboard.DashboardBlock(id, size=None, color=None)[source]

Bases: object

SIZES = ('small', 'medium', 'large', 'full')
default_size = 'normal'
type = None
class shoop.admin.dashboard.DashboardChartBlock(id, size='normal')[source]

Bases: shoop.admin.dashboard.blocks.DashboardBlock

BLOCK_TEMPLATE = '\n <h2 class="block-title"><i class="fa fa-bar-chart"></i>%(title)s</h2>\n <div id="chart-%(id)s"></div>\n <script>\n window.CHART_CONFIGS = window.CHART_CONFIGS || {};\n window.CHART_CONFIGS["%(id)s"] = %(config)s;\n </script>\n '
default_size = 'medium'
get_chart()[source]

Get the actual chart instance for this block.

Returns:The chart (or None, if it can’t be rendered)
Return type:shoop.admin.dashboard.charts.Chart|None
type = 'chart'
class shoop.admin.dashboard.DashboardContentBlock(id, content, size='normal')[source]

Bases: shoop.admin.dashboard.blocks.DashboardBlock

classmethod by_rendering_template(id, request, template_name, context)[source]
type = 'normal'
class shoop.admin.dashboard.DashboardMoneyBlock(id, value, title, currency, **kwargs)[source]

Bases: shoop.admin.dashboard.blocks.DashboardValueBlock

class shoop.admin.dashboard.DashboardNumberBlock(id, value, title, **kwargs)[source]

Bases: shoop.admin.dashboard.blocks.DashboardValueBlock

class shoop.admin.dashboard.DashboardValueBlock(id, value, title, **kwargs)[source]

Bases: shoop.admin.dashboard.blocks.DashboardBlock

default_size = 'small'
type = 'value'
shoop.admin.dashboard.get_activity(request, n_entries=30, cutoff_hours=10)[source]

Get Activity objects from all modules as a list in latest-first order.

Parameters:
  • request (django.http.request.HttpRequest) – Request context
  • n_entries (int) – Number of entries to return in total.
  • cutoff_hours (float) – Calculate cutoff datetime so the oldest entry should be at most this old
Returns:

List of Activity objects
Return type:

list[Activity]