Slack Export Archive Viewer
Project description
Slack Export Viewer
A Slack Export archive viewer that allows you to easily view and share your Slack team's export (instead of having to dive into hundreds of JSON files).
Contents
Overview
slack-export-viewer
is useful for small teams on a free Slack plan (limited to 10,000 messages) who overrun their budget and ocassionally need a nice interface to refer back to previous messages. You get a web interface to easily scroll through all channels in the export without having to look at individual JSON files per channel per day.
slack-export-viewer
can be used locally on one machine for yourself to explore an export or it can be run on a headless server (as it is a Flask web app) if you also want to serve the content to the rest of your team.
Installation
I recommend pipsi
for a nice
isolated install.
pipsi install slack-export-viewer
Or just feel free to use pip
as you like.
pip install slack-export-viewer
slack-export-viewer
will be installed as an entry-point; run from anywhere.
$ slack-export-viewer --help
Usage: slack-export-viewer [OPTIONS]
Options:
-p, --port INTEGER Host port to serve your content on
-z, --archive PATH Path to your Slack export archive (.zip file or
directory) [required]
-I, --ip TEXT Host IP to serve your content on
--no-browser If you do not want a browser to open
automatically, set this.
--channels TEXT A comma separated list of channels to parse.
--no-sidebar Removes the sidebar.
--no-external-references Removes all references to external css/js/images.
--test Runs in 'test' mode, i.e., this will do an archive
extract, but will not start the server, and
immediately quit.
--debug
--help Show this message and exit.
Usage
1) Grab your Slack team's export
- Visit https://my.slack.com/services/export
- Create an export
- Wait for it to complete
- Refresh the page and download the export (.zip file) into whatever directory
2) Point slack-export-viewer
to it
Point slack-export-viewer to the .zip file and let it do its magic
slack-export-viewer -z /path/to/export/zip
If everything went well, your archive will have been extracted, processed, and browser window will have opened showing your #general channel from the export.
CLI
There is now a CLI included as well. Currently the one command you can use is clearing the cache from slack-export-viewer from your %TEMP% directory; see usage:
└———→ slack-export-viewer-cli --help
Usage: slack-export-viewer-cli [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
clean Cleans up any temporary files (including...
Examples
┌— hamza@AURORAONE C:\Users\hamza
└———→ slack-export-viewer-cli clean
Run with -w to remove C:\Users\hamza\AppData\Local\Temp\_slackviewer
┌— hamza@AURORAONE C:\Users\hamza
└———→ slack-export-viewer-cli clean -w
Removing C:\Users\hamza\AppData\Local\Temp\_slackviewer...
Acknowledgements
Credit to Pieter Levels whose blog post and PHP script I used as a jumping off point for this.
Improvements over Pieter's script
slack-export-viewer
is similar in core functionality but adds several things on top to make it nicer to use:
- An installable application
- Automated archive extraction and retention
- A Slack-like sidebar that lets you switch channels easily
- Much more "sophisticated" rendering of messages
- A Flask server which lets you serve the archive contents as opposed to a PHP script which does static file generation
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for slack-export-viewer-0.9.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dfb0b4f8cf69e96f6773b4556981d13e9a91a37e496fa65cb387fbba1f8cdeb8 |
|
MD5 | 6a4e17ef5825042908ca7c0493d9f163 |
|
BLAKE2b-256 | 5af9ae44768792d842e85cd5ff3be5f2f3aeebaec0d3ac701dddae59de35e5fe |
Hashes for slack_export_viewer-0.9.4-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2170ea3fd3cf14f13fc7ffcbf5c4b601ad3d20ebfeb8a057ffe60d53b6d0fdb2 |
|
MD5 | db0c487576f3445528f7a7d62f9e3c90 |
|
BLAKE2b-256 | 96cb48d8df5cd1a80f833e916d54d1973c0decee28c3148c9f601c25020b0d08 |