Skip to content

Commit 5baf146

Browse files
authored
Update README (#16)
1 parent a353b0b commit 5baf146

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# Python-Slack-Discovery-SDK
22

3-
👋🏼 Welcome to the Python-Slack-Discovery-SDK! This project aims to make using the [Slack Discovery API's](https://api.slack.com/enterprise/discovery/methods#methods) easier.
3+
👋🏼 Welcome to the Python-Slack-Discovery-SDK! This project aims to make using the Slack Discovery APIs easier.
44

55
> 🚨 Note: This SDK is only accessible to customer developers with access to the Discovery API (Enterprise accounts) or partners who have been onboarded to the Security and Compliance partner program. To learn more about the Discovery APIs, please [visit our help center](https://slack.com/help/articles/360002079527-A-guide-to-Slacks-Discovery-APIs). 🚨
66
7-
87
# Using the SDK
98

109
Below are the steps needed to use the Discovery SDK.
@@ -14,7 +13,7 @@ Below are the steps needed to use the Discovery SDK.
1413
In order to speed up the development process, we've provided you with a script called
1514
`set_env_vars.sh` in the scripts folder to automate a few things needed to run the SDK.
1615
The script accomplishes the following things using the following code:
17-
* Prints your current Python version (<b>you will need Python version 3.6 or greater for this SDK</b>)
16+
* Prints your current Python version (**you will need Python version 3.6 or greater for this SDK**)
1817
```bash
1918
python3 --version
2019
```
@@ -37,7 +36,7 @@ The script accomplishes the following things using the following code:
3736
🚨 At this point, you'll need to edit the `scripts/set_env_vars.sh` script in an editor of your choice 🚨
3837

3938
Edit the line below, and add in your token with `discovery:read` and `discovery:write` scopes.
40-
```
39+
```bash
4140
export SLACK_DISCOVERY_SDK_TEST_ENTERPRISE_TOKEN='xoxp-**********'
4241
```
4342

@@ -46,7 +45,7 @@ a few other additional environmental variables.
4645

4746
Edit the lines below, and add in the appropriate tokens:
4847

49-
```
48+
```bash
5049
# A normal bot token with many scopes
5150
export SLACK_DISCOVERY_SDK_TEST_BOT_TOKEN = "xoxb-*******"
5251

@@ -119,7 +118,7 @@ chmod +x scripts/run_all.sh
119118
120119
Then, run the script:
121120
122-
```
121+
```bash
123122
./scripts/run_all.sh
124123
```
125124
@@ -128,24 +127,23 @@ you should see debug output in your terminal once the script has finished runnin
128127
129128
Continue reading below to learn what each example does:
130129
131-
💳 <b>`DLP_call_pattern.py`</b> 💳
130+
💳 **`DLP_call_pattern.py`** 💳
132131
* This script involves using the tombstoning capabilities of the Discovery SDK to check for messages that contain sensitive information. If sensitive information is detected by our script (for example a credit card number), the message is tombstoned, and the user is notified that their message is being reviewed.
133132
* Once you run this script, you should see that one of your
134133
messages in the channel which you set in your env variable (SLACK_DISCOVERY_SDK_TEST_CHANNEL_ID) should have been tombstoned. The message should now say `This message is being scanned to make sure it complies with your team’s data security policies.`
135134
136-
🙋🏾‍♀️ <b>`user_based_eDiscovery_with_edits.py`</b> 👩🏻‍🏫
135+
🙋🏾‍♀️ **`user_based_eDiscovery_with_edits.py`** 👩🏻‍🏫
137136
* This script retrieves all of the conversations (channels) and messages a particular user is in. It then outputs those
138137
conversations to a file, and stores them in the following format: `YYYY/MM/DD/user_id/channel_id/discovery_conversations.json`. If the `has_edits` flag is true
139-
for a certain conversation, all edited messages will be found in the `edits` field.
140-
138+
for a certain conversation, all edited messages will be found in the `edits` field.
141139
142-
👩🏻‍🏫 <b>`audit_logs_pattern.py`</b> 👩🏻‍🏫
140+
👩🏻‍🏫 **`audit_logs_pattern.py`** 👩🏻‍🏫
143141
* This script will use the [Audit Logs API](https://api.slack.com/admins/audit-logs) to find all of the
144142
channels that a particular user has created. As is the
145143
case with the `user_based_eDiscovery` script, it will only
146144
be useful if you have a paricular user which you want to see details about. This script will output the channel creation events associated with a particular user_id to in the following format: `YYYY/MM/DD/user_id/audit_logs/public_channel_created.json`.
147145
148-
🙋🏾‍♀️ <b>`user_based_eDiscovery_pattern.py` (Without Edits) </b> 👩🏻‍🏫
146+
🙋🏾‍♀️ **`user_based_eDiscovery_pattern.py` (Without Edits) ** 👩🏻‍🏫
149147
* This is the same as the `user_based_eDiscovery_with_edits.py` script, except it
150148
doesn't capture edits.
151149

0 commit comments

Comments
 (0)