File: PLUGINS.README

package info (click to toggle)
pytrainer 2.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 4,876 kB
  • sloc: python: 15,914; perl: 6,084; xml: 195; sql: 151; makefile: 83; sh: 45
file content (31 lines) | stat: -rw-r--r-- 1,008 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
Information on creating Plugins
===========================================

Plugins are created by:
1) Making a directory in <pytrainer>/plugins/
2) Creating a python class in a file in your directory
	- class must have run(self) function
	- run(self) returns tuple of GPX files to import
3) Creating a conf.xml configuration file in your directory with at least the following information:
	<?xml version="1.0" ?>
	<pytrainer-plugin 
		name="Garmin v2 TCX" 
		description="Import your records from a version 2 TCX file from a Garmin gps device (i.e. Forerunner 405)" 
		plugincode="garminTCXv2"
		pluginbutton="Import from Garmin TCX (version 2)" 
		executable="garmintcxv2" 
	>
	</pytrainer-plugin>

Where
	name: is the name of your plugin
	description: is the description
	plugincode: is the name of the class in your plugin file 
	pluginbutton: is the label that the menu option will have once your plugin is enabled
	executable: is the file that the python class in in (without the .py extension)