Changes between Version 73 and Version 74 of TracDev/PluginDevelopment

Timestamp:

May 7, 2020, 2:45:52 AM (4 years ago)

Author:

Ryan J Ollos

Comment:

Add packaging details.

TracDev/PluginDevelopment

@@ -59 +59 @@
 == Packaging plugins
 
-TracPlugins are packaged as [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs]. You can use [https://pythonhosted.org/setuptools/setuptools.html setuptools] to make a `setup.py` script that will produce a Python egg for your plugin.
+TracPlugins are packaged  using [https://setuptools.readthedocs.io/en/latest/ setuptools], to create an egg or wheel package.
 
-The egg needs to export an [https://pythonhosted.org/setuptools/setuptools.html#dynamic-discovery-of-services-and-plugins entry points] group named `trac.plugins`, listing the names of the modules that Trac should import for the plugin-provided components to get registered. For example:
+The plugin needs to export an [https://setuptools.readthedocs.io/en/latest/setuptools.html#dynamic-discovery-of-services-and-plugins entry points] group named `trac.plugins`, listing the names of the modules that Trac should import for the plugin-provided components to get registered. For example:
 
 {{{#!python
@@ -77 +77 @@
 }}}
 
-This assumes that the `HelloWorldPlugin` example above is defined in the module `helloworld.py` in the `myplugs` package. The entry point ''name'' (in this example "helloworld") is required by the Python egg runtime, but not currently used by Trac. In most cases, you can simply use the qualified module name there.
+This assumes that the `HelloWorldPlugin` example above is defined in the module `helloworld.py` in the `myplugs` package. The entry point ''name'' (in this example `helloworld`) is required by the Python egg runtime, but not currently used by Trac. In most cases, you can simply use the qualified module name there. The `myplugs` directory must contain an `__init__.py` to make it a regular package, but the file can be empty.
+
+The structure of files and directories is:
+{{{
+setup.py
+myplugin/
+myplugin/__init__.py
+myplugin/helloworld.py
+}}}
 
 == !Internationalization/Localization of plugins