iro/offer/__init__.py
branchdevel
changeset 257 31114e40178d
parent 180 55ab949cf0f8
child 274 1653470ccaff
--- a/iro/offer/__init__.py	Wed Mar 28 23:16:37 2012 +0200
+++ b/iro/offer/__init__.py	Thu Mar 29 13:46:37 2012 +0200
@@ -1,3 +1,12 @@
+"""Package all about providers. This packages handles the code for sending a message through a provider.
+
+- :attr:`iro.offer.provider.providers` -- a dict of all available providers
+- :func:`iro.offer.provider.getProvider` -- returns a object, from a provider name
+- :class:`iro.offer.provider.Provider` -- Baseclass for all providers
+- :class:`iro.offer.smtp.SMTP` -- a provider to send emails over smtp
+- :class:`iro.offer.smstrade.Smstrade` -- a provider to send sms via http://smstrade.de
+- :class:`iro.offer.offer.Offer` -- a represantation of an offer, this is used to send (see :mod:`iro.model.offer`).
+"""
 from .offer import Offer
 from .provider import Provider, providers, getProvider
 from .smtp import SMTP