Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/auino/slack-downloader
Slack uploads downloader and organizer
https://github.com/auino/slack-downloader
Last synced: about 2 months ago
JSON representation
Slack uploads downloader and organizer
- Host: GitHub
- URL: https://github.com/auino/slack-downloader
- Owner: auino
- License: mit
- Fork: true (marek/slack-downloader)
- Created: 2016-01-15T18:02:43.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-09-14T08:31:08.000Z (about 2 years ago)
- Last Synced: 2024-05-27T12:08:56.119Z (4 months ago)
- Language: Python
- Homepage:
- Size: 32.2 KB
- Stars: 44
- Watchers: 2
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# slack-downloader
`slack-downloader` is a tool to download/backup [Slack](https://slack.com) files on a local disk.
The program will download latest files uploaded on Slack, on a configured directory.
History of already downloaded files is mantained, in order to avoid duplicate downloads.
Files will be organized inside of a specified directory, with the following form:
```
/-_by_.
```
where `` has the form `%Y%m%d_%H%M%S`.
This project is a fork of [marek/fslack](https://github.com/marek/fslack), used for a different purpose.
### Requirements
* `Slack API Token`: Get it from (https://api.slack.com/web)
* `Python`: The app is written in Python
* `python-requests`: web request library for Python
### Setting up API Access to your Slack Workspace
In order to get your token, you will have to create a new Slack App. You can follow [this tutorial](https://api.slack.com/tutorials/tracks/getting-a-token).
You can create a new app by going to https://api.slack.com/apps and clicking on the `"Create New App"` button.
When you click on the `"Create New App"` button, you will be given the following 2 options:
1. Create an app from scratch
2. Create an app from an app manifest
Select "Create an app from an app manifest" and then copy and paste the text in [slack-app-manifest.yaml](slack-app-manifest.yaml)
This will create an app with permission to read all data in your Slack workspace. It won't have any write permissions.
Once you have created the app, you have to install it in your workspace.
Now - to get the token, go to the `OAuth & Permissions` section in the app settings. Then in the `OAuth Tokens for Your Workspace` section, copy the `Bot User OAuth Token`.
To access app `OAuth & Permissions` settings, you can navigate directly to `https://api.slack.com/apps//oauth?`
Finally, invite the App's bot into the channels from which you want to download the files.
To invite the bot, use `/invite @your-app-name` e.g. `/invite @SlackDataDownloader` as discussed in [this question](https://stackoverflow.com/a/61369364/8691571)
### Installation Instructions
1. Download the Python program:
```
wget https://raw.githubusercontent.com/auino/slack-downloader/master/slack-downloader.py
chmod +x slack-downloader.py
```
2. Open the `slack-downloader.py` script with a text editor and configure it using a [legacy token](https://api.slack.com/custom-integrations/legacy-tokens)
3. Optionally, you can add the program to your `crontab` to automatically check for new shared items on Slack:
```
crontab -e
```
4. Now you have to append the following line (press `i` button to insert data):
```
0 * * * * python /directory_path/slack-downloader.py
```
where `/directory_path/` identifies the path of the directory containing the script, while `0 *` specifies the program has to be called every hour.
5. Hit `:q` to close, saving the file
6. Enjoy!
### Supporters ###
* [kylevedder](https://github.com/kylevedder) for multiple fixes
* [nalt](https://github.com/nalt) for the fix on file downloads
* [paloha](https://github.com/paloha) for resolving API incompatibilities and other fixes
* [i18n-tribe](https://github.com/i18n-tribe) for improving the description to use the tool
### Contacts ###
You can find me on Twitter as [@auino](https://twitter.com/auino).