Metadata

<= Previous Change | Next Change =>

Diff Summary
Title
Date	2007-05-30 19:50	2007-05-31 17:19
Editor	Andrew Plotkin (zarf)	Andrew Plotkin (zarf)

	2007-05-30 19:50 by Andrew Plotkin			2007-05-31 17:19 by Andrew Plotkin
f	1	Metadata is information about information. For [Bo	f	1	Metadata is information about information. For [Bo
	>	odler], this means information about a [package] -		>	odler], this means information about a [package] -
	>	- who created it, when it was created, and so on.		>	- who created it, when it was created, and so on.
	2			2
	3	The metadata for a [package] resides in a file cal		3	The metadata for a [package] resides in a file cal
	>	led `Metadata` in the package directory. (See [pac		>	led `Metadata` in the package directory. (See [pac
	>	kage format].)		>	kage format].)
t			t	4
				5	## Metadata file format
				6
				7	Lines, of the form
				8
				9	key: value
				10
				11	Blank lines, and lines beginning with `#`, are ign
				>	ored. Whitespace is optional at the beginning and
				>	end of each line, and around the `:`. Newline form
				>	at may be Mac, Windows, or Unix.
				12
				13	You can have more than one line with the same key.
				>	(For example, a package could have several depend
				>	encies.) If you specify several values for a key w
				>	here only one makes sense, the first one is used.
				14
				15	Keys should be namespaced -- they should contain a
				>	t least one `.`, with the part before the `.` bein
				>	g the namespace. (See below.)
				16
				17	## Boodler metadata terms
				18
				19	Metadata entries with particular meaning for Boodl
				>	er begin with `boodler.`
				20
				21	* `boodler.package` : The package name (mandatory)
				>
				22	* `boodler.version` : The version string (default
				>	`1.0`)
				23	* `boodler.main` : Name of the Python module in th
				>	e package file (or `.`). See [package format].
				24	* `boodler.api_required` : The boodler API [versio
				>	n spec]. (If not present, the package is saying th
				>	at it works with all Boodler versions.)
				25	* `boodler.requires` : A package name (optionally
				>	followed by a version number). This indicates a de
				>	pendency on the given package; it must be installe
				>	d for this package to work.