xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-zulip-api/zulip/integrations/trello/README.md

24 lines
796 B
Markdown
Raw Normal View History

integrations/trello: Improve the Trello script. This commit makes a bunch of improvements: 1. Use format() for string formatting instead of the old style. 2. Stop returning stuff where we don't have to. 3. URL generation should not be done by the script, especially since our eventual goal is for the Zulip server to automatically generate a webhook URL. So the user should be able to supply the URL in the config file. Plus, this makes it easier to test the script with non-Zulip URLs (such as RequestBin). 4. Removed unnecessary arguments.
2018-04-03 20:22:10 -04:00
# A script that automates setting up a webhook with Trello
Add Trello integration script This is a small Python script to create Trello Webhooks for Zulip. It builds and sends the Trello API requests required to create the Trello webhook.
2018-03-24 13:58:54 -04:00
Usage :
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-14 15:54:40 -04:00
1. Make sure you have all of the relevant Trello credentials before
executing the script:
Add Trello integration script This is a small Python script to create Trello Webhooks for Zulip. It builds and sends the Trello API requests required to create the Trello webhook.
2018-03-24 13:58:54 -04:00
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-14 15:54:40 -04:00
- The Trello API KEY
- The Trello TOKEN
integrations/trello: Improve the Trello script. This commit makes a bunch of improvements: 1. Use format() for string formatting instead of the old style. 2. Stop returning stuff where we don't have to. 3. URL generation should not be done by the script, especially since our eventual goal is for the Zulip server to automatically generate a webhook URL. So the user should be able to supply the URL in the config file. Plus, this makes it easier to test the script with non-Zulip URLs (such as RequestBin). 4. Removed unnecessary arguments.
2018-04-03 20:22:10 -04:00
- The Zulip webhook URL
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-14 15:54:40 -04:00
- Trello board name
- Trello board ID
Add Trello integration script This is a small Python script to create Trello Webhooks for Zulip. It builds and sends the Trello API requests required to create the Trello webhook.
2018-03-24 13:58:54 -04:00
2. Execute the script :
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-14 15:54:40 -04:00
$ 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).
Reference in a new issue Copy permalink