paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-09 16:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

integrations: Add detailed module docstrings.

Browse Source
This commit is contained in:
Tim Abbott
2016-08-04 12:13:25 -07:00
parent 4a7e6e852f
commit 028efdcb78
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
zerver/lib/integrations.py
View File

@@ -2,6 +2,22 @@ from typing import Dict, List, Optional
from django.conf import settings from django.conf import settings
from django.conf.urls import url from django.conf.urls import url
"""This module declares all of the (documented) integrations available
in the Zulip server. The Integration class is used as part of
generating the documentation on the /integrations page, while the
WebhookIntegration class is also used to generate the URLs in
`zproject/urls.py` for webhook integrations.
To add a new non-webhook integration, add code to the INTEGRATIONS
dictionary below.
To add a new webhook integration, declare a WebhookIntegration in the
WEBHOOK_INTEGRATIONS list below (it will be automatically added to
INTEGRATIONS).
Over time, we expect this registry to grow additional convenience
features for writing and configuring integrations efficiently.
"""
class Integration(object): class Integration(object):
DEFAULT_LOGO_STATIC_PATH = 'static/images/integrations/logos/{name}.png' DEFAULT_LOGO_STATIC_PATH = 'static/images/integrations/logos/{name}.png'