A Divio Addon should be packaged like a standard Django application, and needs be accompanied by some additional files for Divio's use.
These files should all be placed in the root directory of your Addon, leaving you with a file structure that looks like:
your-addon/ # the outer package directory
your_addon/ # the inner module directory
addon.json, these are all standard Python packaging files.
Tip: If you use the files Divio provides when creating a new Addon on Divio, you will have a set of minimal but adequate files to work with.
The only strictly-required file, and needed for divio addon validate to run successfully.
Here’s an example of a configuration file:
The package name of the application; this needs to match the
name option in
A list of applications that needs to be added to
An Addon needs to be packaged in the usual Python way, starting with the
README.rst as provided by Divio will be empty unless you have a Description for it in managing your Addons on Divio. You can of course you can edit the file manually, but you will need to add the Description on Divio separately.
This should be a short introduction what the package is about, and provide some basic instructions for non-Divio users, if the application can be used independently.
Include a link back to Divio:
- In RST: This package is compatible with
Any Addon that you would like others to be able to use must have a valid licence file, otherwise you will be unable to share it on Divio.
Divio has a set of licences to choose from in managing your Addons, but you can add your own.
MANIFEST.in file lists the locations of resources such as templates that need to be included in an installation.
__init.py__ contains the application version. This starts at
0.0.1 by default, since it’s the first version of any new application.
We strongly recommend following a meaningful versioning scheme, such as Semantic Versioning.