xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-zulip-api/zulip_bots/zulip_bots/bots/stack_overflow/doc.md
Dhruv Thakker 9c5eaa2f1b stack_overflow : Create StackOverflow bot. 
(Use stackoverflow APIs to answer queries.)
2018-03-11 14:25:03 -04:00

1.2 KiB
Raw Blame History

StackOverflow Bot

The StackOverflow bot is a Zulip bot that will search Stackoverflow for a provided set of keywords or a question, and fetch a link to the associated query. The link is returned to the same stream it was @mentioned in

The Stackoverflow bot uses the StackExchange API to obtain the search results it returns

Using the StackOverflow bot is as simple as mentioning @<stackoverflow-bot-name>, followed by the query:

@<stackoverflow-bot-name> <query>

Setup

Beyond the typical obtaining of the zuliprc file, no extra setup is required to use the StackOverflow Bot

Usage

  1. @<stackoverflow-bot-name> <query> - fetches the link to the appropriate StackOverflow questions.

    • For example, @<stackoverflow-bot-name> rest api will return the links having questions related to rest api.

  2. If there are no questions related to the query, the bot will respond with an error message:

    I am sorry. The search query you provided is does not have any related results.


  1. If no query is provided, the bot will return the help text:

    Please enter your message after @mention-bot