1==========================
2Loader: Egg Test discovery
3==========================
4
5
6What is Egg Discovery
7---------------------
8
9Sometimes Python Eggs are marked as zip-safe and they can be installed zipped,
10instead of unzipped in an ``.egg`` folder. See http://peak.telecommunity.com/DevCenter/PythonEggs for more details.
11The normal ``nose2.plugins.loader.discovery`` plugin ignores modules located inside zip files.
12
13The Egg Discovery plugin allows nose2 to discover tests within these zipped egg files.
14
15This plugin requires ``pkg_resources`` (from ``setuptools``) to work correctly.
16
17
18Usage
19-----
20
21To activate the plugin, include the plugin module in the plugins list
22in ``[unittest]`` section in a config file::
23
24  [unittest]
25  plugins = nose2.plugins.loader.eggdiscovery
26
27Or pass the module with the :option:`--plugin` command-line option::
28
29  nose2 --plugin=nose2.plugins.loader.eggdiscovery module_in_egg
30
31
32Reference
33---------
34
35.. autoplugin :: nose2.plugins.loader.eggdiscovery.EggDiscoveryLoader
36