Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/florczakraf/slackfs
Browse and upload slack files directly from your filesystem
https://github.com/florczakraf/slackfs
fuse fuse-filesystem fusepy python slack
Last synced: 30 days ago
JSON representation
Browse and upload slack files directly from your filesystem
- Host: GitHub
- URL: https://github.com/florczakraf/slackfs
- Owner: florczakraf
- License: mit
- Created: 2020-02-16T21:22:52.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-22T22:07:17.000Z (almost 5 years ago)
- Last Synced: 2024-11-06T00:38:22.782Z (3 months ago)
- Topics: fuse, fuse-filesystem, fusepy, python, slack
- Language: Python
- Homepage: https://blog.andr.host/posts/2020/02/23-fuse/
- Size: 27.3 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# slackfs
Browse and upload slack files directly from your filesystem.
## How does it work?
This is a simple [FUSE](https://en.wikipedia.org/wiki/Filesystem_in_Userspace) application that
talks to Slack using API in the backend. Right now it runs in a single-threaded foreground mode.
## Usage
```
$ pip install -r requirements.txt
$ export SLACKFS_TOKEN=xoxp-your-token
$ ./slackfs.py /path/to/mountpoint
```
It was tested with legacy tokens that can be generated at https://api.slack.com/legacy/custom-integrations/legacy-tokens.
## Environment variables
- `SLACKFS_TOKEN` -- token for the underlying Slack client
- `SLACKFS_LOG_LEVEL` -- the usual [Python logging level](https://docs.python.org/3/library/logging.html#levels),
defaults to `ERROR`
## Filesystem layout
In the root of the filesystem there are directories that represent channels you are a member of.
Inside a channel you can find files that have been shared to it. There is a following naming
convention for files: `SLACK-FILE-ID_ORIGNAL-FILE-NAME` to avoid name overlapping. `stat` on a file
reports its real creation time so it is possible to list files by it (e.g. `ls -lat | head`).
```
$ tree
.
├── some-channel
│ ├── FU0BQXXXX_Screenshot_2020-02-21_21-21-29.png
│ ├── FUCKUXXXX_somefile
│ └── FUCL2XXXX_Screenshot_2020-02-21_21-23-41.png
├── empty-channel
├── other-channel
│ ├── FJPC5XXXX_dh.png
│ ├── FJS36XXXX_gh.png
...
```
## Current limitations
Only some of the FUSE callbacks are implemented to provide the basic functionality. More sophisticated
are provided by the `fusepy` library and most likely return unconditional success or some garbage.
There is hardly any error handling in slackfs which in turn cause syscalls to return errors to applications.
New directory creation is UB. Creating files in root of the filesystem is UB, as is modifying existing ones.
There is absolutely no slack api rate limit respecting implemented on slackfs side. Unless official slack
python api library handles that itself, your key or even account might be temporarily blocked.
At the moment there will be at most some 200 channels visible and each of them will contain at most 200
files (both arbitrarily chosen by the slack's api).
Channels and files are fetched lazily only once, there is no way to *invalidate cache* other than remounting
the whole filesystem. However, after a successful upload of a new file, it's local name will change to reflect
the aformentioned naming convention.