← Back to branch summary

~qajenkinsbot/qa-dashboard/production

« back to all changes in this revision

Viewing changes to common/plugin.txt

  • Committer: Joe Talbott
  • Date: 2013-05-24 20:25:28 UTC
  • mto: (1.1.427 qa-dashboard)
  • mto: This revision was merged to the branch mainline in revision 25.
  • Revision ID: joe.talbott@canonical.com-20130524202528-4ebxn4ly61qtfxpl
plugins - Add basic plugin architecture.

* adds support for 'plugins.py'.
* adds base classes for apps to define extensions and KPIs.
* adds dashboard app KPI management commands.

Designed-By: Andy Doan <andy.doan@canonical.com>

Show diffs side-by-side

added added

removed removed

Lines of Context:
common/plugin.txt
 
1
 
 
2
# QA Dashboard
 
3
# Copyright 2013 Canonical Ltd.
 
4
 
 
5
# This program is free software: you can redistribute it and/or modify it
 
6
# under the terms of the GNU Affero General Public License version 3, as
 
7
# published by the Free Software Foundation.
 
8
 
 
9
# This program is distributed in the hope that it will be useful, but
 
10
# WITHOUT ANY WARRANTY; without even the implied warranties of
 
11
# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
 
12
# PURPOSE.  See the GNU Affero General Public License for more details.
 
13
 
 
14
# You should have received a copy of the GNU Affero General Public License
 
15
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
16
 
 
17
How to make your app a plugin for the QA Dashboard.
 
18
 
 
19
- At the top-level of your app module include dashboard.py
 
20
 
 
21
dashboard.py contents
 
22
 
 
23
- sub-classes of KPI from common/plugin_helper.py
 
24
- a sub-class of Extension from common/plugin_helper.py
 
25
- a entry 'extension' that points to the Extension.