stawros/slack-exporter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

update readme to reflect current Slack UI

Browse source
This commit is contained in:
Martin Berka 2023-11-20 09:52:41 -08:00
parent d98d00f36b
commit dcb99e35a1
No known key found for this signature in database
GPG key ID: 8C76DF6B6E1B238B
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -9,10 +9,10 @@ A similar service is provided by Slack for workspace admins at [https://my.slack
There are two ways to use `slack-exporter` (detailed below). Both require a Slack API token to be able to communicate with your workspace.
1. Visit [https://api.slack.com/apps/](https://api.slack.com/apps/) and sign in to your workspace.
2. Click `Create New App`, enter a name (e.g., `Slack Exporter`), and select your workspace.
3. In prior versions of the Slack API, OAuth permissions had to be specified manually. Now, when prompted for an App Manifest, just paste in the contents of the `slack.yaml` file in the root of this repo.
2. Click `Create New App`. If prompted to select "how you’d like to configure your app’s scopes", choose the "app manifest option" (you will otherwise be prompted to enter an app name and may need to go through more steps to set up permissions instead of the short way in step 3), then select your workspace.
3. You should then be prompted for an App Manifest; paste the contents of the `slack.yaml` file (in the root of this repo) into the YAML box.
4. Select `Install to Workspace` at the top of that page (or `Reinstall to Workspace` if you have done this previously) and accept at the prompt.
5. Copy the `OAuth Access Token` (which will generally start with `xoxp` for user-level permissions)
5. Copy the `OAuth Access Token` (which will generally start with `xoxp` for user-level permissions and may be located in a section like "OAuth & Permissions" in the sidebar).
## Usage
@ -32,7 +32,8 @@ There are two ways to use `slack-exporter` (detailed below). Both require a Slac
export SLACK_USER_TOKEN=xoxp-xxxxxxxxxxxxx...
```
2. Run `python exporter.py --help` to view the available export options.
2. If you cloned this repository, make sure that dependencies are installed by running `pip install -r requirements.txt` in the directory.
3. Run `python exporter.py --help` to view the available export options. You can test that access is working by listing the available conversations: `python exporter.py --lc`.
### As a Slack bot