Package Format

Boodler will have a standard format for distributing soundscapes. A package will have a unique name and version number.

The package format is a Zip file of Python code and/or sound files, plus a manifest and metadata.

The Zip file must contain a file called Metadata. It may also contain a Resources file. (See Metadata, Resources.)

(The Zip file may contain either a group of files (and subdirectories), or a single directory of files (and subdirectories). In other words, Boodler accepts both the "all files at top level" or the "wrapped in a directory" style of Zip archive.)

Sound files

If the package contains sound files, they should be listed in the Resources file. (They don't have to be listed, but if they're not, then package management tools -- like the web site -- won't know about them.) When the package is imported, the sound files will be attributes of the package object.

Python code

If the package contains Python code (typically agents), the Metadata file must have a boodler.main line which gives the Python module name. This file will then become the package object, when the package is imported.

You can also include a group of Python files, organized as a (Python) package, with the usual __init__.py file to glue them together. The __init__.py will then become the package object.