hfaran / slack-export-viewer

A Slack Export archive viewer that allows you to easily view and share your Slack team's export
https://pypi.python.org/pypi/slack-export-viewer
MIT License
966 stars 193 forks source link

Documentation of Archive Format? #131

Open supermitch opened 4 years ago

supermitch commented 4 years ago

I'm writing code using Slack's discovery APIs, which means I'm not getting an entire export of the workspace as a .zip. However, I'd love to use your script to convert to HTML, regardless.

To do that, I would like to essentially build my own archive.zip. However, that would require understanding exactly what your code is looking for, in terms of archive structure.

Note: I'm guessing you are also making assumptions about the archive format, and that this is not documented anywhere in Slack, which is why I am raising the issue here. I will check Slack and see if they have anything also.

justinflipflops commented 4 years ago

The archive isn't anything special, just unzip an export from slack and look at it. Bunch of json files. most of what you'll ever need is easily inferable from the files.

huyz commented 4 years ago

@supermitch You may be duplicating work. See https://github.com/wolever/wayslack and this PR (and my upcoming updates to both—see issues)

supermitch commented 4 years ago

Slack send me this link: https://slack.com/intl/en-ca/help/articles/220556107-How-to-read-Slack-data-exports

I still think this project has room for documentation, but probably hard to beat this.

@huyz I saw your (newly forked) project, but I'm not sure how I can make use of it for discovery. I don't see how to export a specific user's conversations, for example.

huyz commented 4 years ago

@supermitch my fork allows getting a private token for a specific user so that you can export the user’s private and public messages and files. The easiest thing for u to do is run it, take a look at the directory structure and json files. Do the same with the manual export from the Slack web UI. Compare and analyze. Don’t be afraid to dive into the json files. You real don’t need docs