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).
![Preview](screenshot.png)
## 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.
## Usage
### 1) Grab your Slack team's export
* Visit [https://my.slack.com/services/export](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
```bash
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.
## Installation
I recommend [`pipsi`](https://github.com/mitsuhiko/pipsi) for a nice
isolated install.
```bash
pipsi install slack-export-viewer
```
Or just feel free to use `pip` as you like.
```bash
pip install slack-export-viewer
```
`slack-export-viewer` will be installed as an entry-point; run from anywhere.
```bash
$ 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.
--debug
--help Show this message and exit.
```
## Acknowledgements
Credit to Pieter Levels whose [blog post](https://levels.io/slack-export-to-html/) 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
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).
![Preview](screenshot.png)
## 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.
## Usage
### 1) Grab your Slack team's export
* Visit [https://my.slack.com/services/export](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
```bash
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.
## Installation
I recommend [`pipsi`](https://github.com/mitsuhiko/pipsi) for a nice
isolated install.
```bash
pipsi install slack-export-viewer
```
Or just feel free to use `pip` as you like.
```bash
pip install slack-export-viewer
```
`slack-export-viewer` will be installed as an entry-point; run from anywhere.
```bash
$ 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.
--debug
--help Show this message and exit.
```
## Acknowledgements
Credit to Pieter Levels whose [blog post](https://levels.io/slack-export-to-html/) 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
slack-export-viewer-0.3.0.tar.gz
(11.8 kB
view hashes)
Built Distribution
Close
Hashes for slack-export-viewer-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0582d7b8146c6d10a784667f7772b88000d8cb7ed026293b618756c490827ff2 |
|
MD5 | 11483a82e0b7c3e26d173a15dbbc8fdf |
|
BLAKE2b-256 | db6443da05219ca406a820df355924d3583e443e3a6216a7bfc48442469623f3 |
Close
Hashes for slack_export_viewer-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2cf900cba9599ba5ff7b46a830573f6f3e9f60c094f519ab5775b7ffe8ea07ce |
|
MD5 | e9138db769990311c37e0c8c2d13e82a |
|
BLAKE2b-256 | bdbaed9470c51710836b7062d37adefb7b7ac7e15949bec1ac6e07aa5abdb1c5 |