certbot/docs/plugins.rst

20 lines
838 B
ReStructuredText
Raw Normal View History

2015-03-26 09:55:23 -04:00
=======
Plugins
=======
2015-03-26 18:12:40 -04:00
Let's Encrypt client supports dynamic discovery of plugins through the
`setuptools entry points`_. This way you can, for example, create a
custom implementation of `~letsencrypt.interfaces.IAuthenticator` or
the `~letsencrypt.interfaces.IInstaller` without having to merge it
with the core upstream source code. An example is provided in
2015-03-26 18:12:40 -04:00
``examples/plugins/`` directory.
.. warning:: Please be aware though that as this client is still in a
developer-preview stage, the API may undergo a few changes. If you
believe the plugin will be beneficial to the community, please
consider submitting a pull request to the repo and we will update
it with any necessary API changes.
2015-03-27 15:29:27 -04:00
2015-03-26 18:12:40 -04:00
.. _`setuptools entry points`:
https://pythonhosted.org/setuptools/setuptools.html#dynamic-discovery-of-services-and-plugins