xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Annotate API scripts.

Browse source
This commit is contained in:
Tim Abbott 2016-10-15 22:32:04 -07:00
parent 28b697ac9d
commit 43bf07bf15
3 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
bin/zulip-send
View file

@ -27,12 +27,18 @@ import os
import optparse import optparse
import logging import logging
from typing import Any, Dict, List, Optional
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
import zulip
logging.basicConfig() logging.basicConfig()
log = logging.getLogger('zulip-send') log = logging.getLogger('zulip-send')
def do_send_message(client, message_data ): def do_send_message(client, message_data ):
# type: (zulip.Client, Dict[str, Any]) -> bool
'''Sends a message and optionally prints status about the same.''' '''Sends a message and optionally prints status about the same.'''
if message_data['type'] == 'stream': if message_data['type'] == 'stream':
@ -49,6 +55,7 @@ def do_send_message(client, message_data ):
return False return False
def main(argv=None): def main(argv=None):
# type: (Optional[List[str]]) -> int
if argv is None: if argv is None:
argv = sys.argv argv = sys.argv
@ -63,10 +70,6 @@ def main(argv=None):
'--user' and '--api-key' arguments. '--user' and '--api-key' arguments.
""" """
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
import zulip
parser = optparse.OptionParser(usage=usage) parser = optparse.OptionParser(usage=usage)
# Grab parser options from the API common set # Grab parser options from the API common set

3
examples/print-events
View file

@ -26,6 +26,8 @@ import sys
import os import os
import optparse import optparse
from typing import Any, Dict
usage = """print-events --user=<bot's email address> --api-key=<bot's api key> [options] usage = """print-events --user=<bot's email address> --api-key=<bot's api key> [options]
Prints out certain events received by the indicated bot or user matching the filter below. Prints out certain events received by the indicated bot or user matching the filter below.
@ -44,6 +46,7 @@ parser.add_option_group(zulip.generate_option_group(parser))
client = zulip.init_from_options(options) client = zulip.init_from_options(options)
def print_event(event): def print_event(event):
# type: (Dict[str, Any]) -> None
print(event) print(event)
# This is a blocking call, and will continuously poll for new events # This is a blocking call, and will continuously poll for new events

3
examples/print-messages
View file

@ -26,6 +26,8 @@ import sys
import os import os
import optparse import optparse
from typing import Any, Dict
usage = """print-messages --user=<bot's email address> --api-key=<bot's api key> [options] usage = """print-messages --user=<bot's email address> --api-key=<bot's api key> [options]
Prints out each message received by the indicated bot or user. Prints out each message received by the indicated bot or user.
@ -44,6 +46,7 @@ parser.add_option_group(zulip.generate_option_group(parser))
client = zulip.init_from_options(options) client = zulip.init_from_options(options)
def print_message(message): def print_message(message):
# type: (Dict[str, Any]) -> None
print(message) print(message)
# This is a blocking call, and will continuously poll for new messages # This is a blocking call, and will continuously poll for new messages