Module e.c.u.dist

Part of elisa.core.utils

Functions used to extend setuptools and add elisa specific metadata when distributing plugins.
Line # Kind Name Docs
55 Class Distribution Undocumented
70 Class SDist Undocumented
122 Class LocaleBuildPy create .mo files from .po locales if needed
133 Class TrialTest Twisted Trial setuptools command
189 Class Clean Undocumented
204 Function override_check_test_suite Undocumented
211 Function write_dict DOCME
225 Function mappings_from_text Unserialise mappings from a string text. Mappings are lists of 2-uplets.
249 Function text_from_mappings Takes a mappings and return a serialised form. Mappings are list of
271 Function read_mappings Setuptools compliant deserialiser for mappings.
278 Function write_mappings Setuptools compliant serialiser for mappings.
300 Function assert_list_of_string_tuples_or_none Verify that value is a list of tuples of string
314 Function assert_dict_or_none Verify that value is a dictionary
320 Function find_packages_internal Undocumented
335 Function find_packages Undocumented
352 Function find_plugins Undocumented
390 Function elisa_setup Undocumented
436 Class bdist_elisa A customized bdist_egg command that creates .elisa.egg files. They
450 Class build_po Compile po files to mo files and ship mo files as package_data of
473 Function is_development_egg Check if the distribution is a development egg.
486 Function get_plugin_toplevel_directory Get the top level directory of a plugin distribution.
288 Function _all Undocumented
def override_check_test_suite(dist, attr, value):
Undocumented
def write_dict(cmd, basename, filename, force=False):
DOCME
def mappings_from_text(text):

Unserialise mappings from a string text. Mappings are lists of 2-uplets.

Example: 
   key1 = value1
   key2 = value2a
   key2 = value2b
is deserialised into: 
   [("key1", "value1"), ("key2", "value2a"), ("key2", "value2b")]
def text_from_mappings(mappings):

Takes a mappings and return a serialised form. Mappings are list of 2-uplets.

Example: 
   [("key1", "value1"), ("key2", "value2a"), ("key2", "value2b")]
is serialised into: 
   key1 = value1
   key2 = value2a
   key2 = value2b
def read_mappings(iter_lines):
Setuptools compliant deserialiser for mappings.
def write_mappings(cmd, basename, filename, force=False):
Setuptools compliant serialiser for mappings.
def _all(iterable):
Undocumented
def assert_list_of_string_tuples_or_none(dist, attr, value):
Verify that value is a list of tuples of string
def assert_dict_or_none(dist, attr, value):
Verify that value is a dictionary
def find_packages_internal(path='.'):
Undocumented
def find_packages(path='.'):
Undocumented
def find_plugins(bundle_name, plugins_dir='.', prefix='', excludes=()):
Undocumented
def elisa_setup(name, description, long_description, version, license, author, author_email, namespace, plugins_dir):
Undocumented
def is_development_egg(dist):

Check if the distribution is a development egg.

Development eggs store egg-info and python code in the same toplevel directory.
Parametersdistplugin distribution (type: Distribution )
def get_plugin_toplevel_directory(dist):

Get the top level directory of a plugin distribution.

Regular eggs and development eggs store files in different locations. Use this function to access the top level directory of a plugin eg: 
   toplevel_directory = get_plugin_toplevel_directory(dist)
   sub_directory = '%s/%s' % (toplevel_directory, 'sub')
   requirement = pkg_resources.Requirement.parse(dist.project_name)
   if pkg_resources.resource_isdir(requirement, sub_directory):
       real_sub_path = pkg_resources.resource_filename(requirement,
               sub_directory)
Parametersdistplugin distribution (type: Distribution )
API Documentation for Elisa Media Center, generated by pydoctor at 2008-11-17 18:23:07.