Resources

A resource is any feature provided by a package. Resources currently include sound (sample) files and Boodler agents. Other resource types may come along in the future.

Resources should be listed in a file called Resources, in the package directory. (See package format.) Resources do not have to be listed, but the Resources listing is how package management tools know about them.

Resources file format

The file is divided into sections, one for each resource. A section begins with a line that begins with a colon:

:resourcename

A resource name must be a valid Python identifier (possibly including dots). For example: resname or modname.resname. This identifier is where the resource can be found in its root module.

The resource name is followed by the resource's metadata; zero or more lines defining key-value pairs. These have the same format as in the Metadata file.

Resource metadata

Dublin Core metadata terms may be used to describe the title of a resource, its author, and so on. See the Metadata page for details.

Besides those, Boodler pays special attention to the following terms:

• boodler.use : The purpose this resource serves. The uses currently defined are sound and agent.
• boodler.filename : The filename, for a resource stored in a data file. This must be in universal format: relative to the module root, and written with forward slashes, not backslashes.