Package Format

<= Previous Change | Next Change =>

Diff Summary
Title
Date 2007-05-30 19:40 2007-05-30 20:05
Editor Andrew Plotkin (zarf) Andrew Plotkin (zarf)

2007-05-30 19:40 by Andrew Plotkin
2007-05-30 20:05 by Andrew Plotkin
f1Boodler will have a standard format for distributif1Boodler will have a standard format for distributi
>ng [soundscapes]. A [package] will have a unique [>ng [soundscapes]. A [package] will have a unique [
>Package Name|name] and [version number].>Package Name|name] and [version number].
22
3The package format is a Zip file of Python code an3The package format is a Zip file of Python code an
>d/or sound files, plus a manifest and metadata.>d/or sound files, plus a manifest and metadata.
tt4
5The Zip file must contain a file called `[Metadata
 >]`. It may also contain a `[Resources]` file.
6
7(The Zip file may contain either a group of files 
 >(and subdirectories), or a single directory of fil
 >es (and subdirectories). In other words, Boodler a
 >ccepts both the "all files at top level" or the "w
 >rapped in a directory" style of Zip archive.)
8
9## Sound files
10
11If the package contains sound files, they should b
 >e listed in the [Resources] file. (They don't have
 > to be listed, but if they're not, then package ma
 >nagement tools -- like the web site -- won't know 
 >about them.) When the package is imported, the sou
 >nd files will be attributes of the package object.
 >
12
13## Python code
14
15If the package contains [Python] code (typically [
 >agents]), the [Metadata] file must have a `boodler
 >.main` line which gives the Python module name. Th
 >is file will then become the package object, when 
 >the package is imported.
16
17You can also include a group of Python files, orga
 >nized as a (Python) package, with the usual `__ini
 >t__.py` file to glue them together. The `__init__.
 >py` will then become the package object.
Package Format - last changed 2007-05-30 20:09 by Andrew Plotkin (zarf)