python-zulip-api/zulip/integrations/trello/README.md
Eeshan Garg 1de6613825 integrations/trello: Stop using config files in the Trello script.
A few users have complained about how hard it is to find the
Trello script on their systems after installing the `zulip`
package. One way to solve this issue is to make the Trello
script a part of the exported console scripts in the zulip
package, which would mean that the user would not have to
navigate to a particular directory in order to find the script,
but could run it from a terminal directly.

However, to make this happen, we need to minimize the script's
reliance on external configuration files, because we don't want
the user to have to figure out where the config file lives.
2018-09-25 22:28:25 -02:30

24 lines
796 B
Markdown

# A script that automates setting up a webhook with Trello
Usage :
1. Make sure you have all of the relevant Trello credentials before
executing the script:
- The Trello API KEY
- The Trello TOKEN
- The Zulip webhook URL
- Trello board name
- Trello board ID
2. Execute the script :
$ python zulip_trello.py --trello-board-name <trello_board_name> \
--trello-board-id <trello_board_id> \
--trello-api-key <trello_api_key> \
--trello-token <trello_token> \
--zulip-webhook-url <zulip_webhook_url>
For more information, please see Zulip's documentation on how to set up
a Trello integration [here](https://zulipchat.com/integrations/doc/trello).