The Project is a structure which permits to manage different objects.

It stores metadata (alias, author, description, version, license, ...) and data (src, models, images, ...).

You have here the default architecture of the project saved in directory "project".

/project

oaproject.cfg (Configuration file) /model (Files sources, Script Python, LPy...) /control (Control, like color map or curve) /world (scene, scene 3D) /cache (Intermediary saved objects) /data (Data files like images, .dat, ...) /lib (Contains python modules and packages) /startup (Preprocessing scripts) .py (Preprocessing scripts) *import.py (Libs and packages to import in preprocessing)

use:

project = Project(path="/path/to/proj/project")
project.add(category="model", filename="hello.py", content="print 'Hello World'")
project.author = "John Doe"
project.description = "This project is used to said hello to everyone"
project.save()

exception core.project.project.ErrorItemExistsInProject(*args, **kargs)

Bases: openalea.core.customexception.CustomException

desc = u'As item is in project yet, you cannot add it again. Use replacement instead'

message = u'Item %(name)s is in project yet'

title = u'Error: item exists in project yet.'

class core.project.project.Project(path, **kwargs)

Bases: openalea.grapheditor.observer.Observed

add(category, obj=None, **kwargs)

add_item(category, obj=None, **kwargs)

delete()

get(category, name, **kwargs)

get_item(category, filename)

get_model(filename)

get_runnable_model(name)

items(category, **kwds)

move(dest)

remove(category, obj=None, **kwargs)

remove_item(category, obj=None, **kwargs)

rename(new)

rename_item(category, old, new)

run(filename, *args, **kwargs)

run_model(model, *args, **kwargs)

save()

Save a manifest file on disk. It name is defined by config_filename.

It contains list of files that are inside project (manifest) and metadata (author, version, ...).

save_metadata()

start(*args, **kwargs)

Load controls if available, execute all files in startup.

stop(*args, **kwargs)

valid_item_name(category, name)

DEFAULT_CATEGORIES = OrderedDict([('cache', {'title': 'Temporary Data'}), ('data', {'title': 'Data'}), ('model', {'title': 'Model'}), ('world', {'title': 'World'}), ('startup', {'title': 'Startup'}), ('doc', {'title': 'Documentation'}), ('lib', {'title': 'Libraries'})])

DEFAULT_METADATA = OrderedDict([('alias', Control('alias', IStr(), value='MyProject')), ('icon', Control('icon', IFileStr(filter="All (*)", save=False), value='')), ('authors', Control('author', ISequence(), value=[])), ('description', Control('description', IStr(), value='')), ('long_description', Control('long_description', IStr(), value='')), ('citation', Control('citation', IStr(), value='')), ('url', Control('url', IStr(), value='')), ('dependencies', Control('dependencies', ISequence(), value=[])), ('license', Control('license', IStr(), value='')), ('version', Control('version', IStr(), value='0.1'))])

MODE_COPY = 'copy'

MODE_LINK = 'link'

config_filename = 'oaproject.cfg'

icon_path

Returns:the complete path of the icon. To modify it, you have to modify the path of project, the name of project and/or the self.icon.

name

path

projectdir