slack cleanerダウンロード - slack cleanerソースコードのダウンロード

slack cleaner

その他のソースコード

Bugfix More than 100 Channels

ダウンロード

たるみクリーナー

Slack 上のメッセージとファイルを一括削除します。

これは https://github.com/kfei/slack-cleaner のフォークです

改良された Python モジュールベースのバージョンは https://github.com/sgratzl/slack_cleaner2 にあります。

インストール

Pip からインストールします。

pip install slack-cleaner

現在の開発バージョン:

 pip install -e git+https://github.com/sgratzl/slack-cleaner.git#egg=slack-cleaner

Docker を好む場合は、事前に構築された Docker イメージもあります。

docker pull sgratzl/slack-cleaner

コマンドごとにdocker run -it --rm sgratzl/slack-cleaner -c "slack-cleaner ..."を使用するか、 docker run -it --rm sgratzl/slack-cleanerを使用してシェルにジャンプします。

Fedora または EPEL7 用のインストール

@rapgro は Fedora と EPEL7 の両方のパッケージを保守しています

 # Fedora
dnf install slack-cleaner
# EPEL7
yum install -y epel-release ; yum install slack-cleaner

引数

 usage: slack-cleaner [-h] --token TOKEN [--log] [--quiet] [--rate RATE]
                     [--as_user] [--message | --file | --info] [--regex]
                     [--channel CHANNEL] [--direct DIRECT] [--group GROUP]
                     [--mpdirect MPDIRECT] [--user USER] [--botname BOTNAME]
                     [--bot] [--keeppinned] [--after AFTER] [--before BEFORE]
                     [--types TYPES] [--pattern PATTERN] [--perform]

optional arguments:
  -h, --help           show this help message and exit
  --token TOKEN        Slack API token (https://api.slack.com/web) or SLACK_TOKEN env var
  --log                Create a log file in the current directory
  --quiet              Run quietly, does not log messages deleted
  --proxy              Proxy Server url:port
  --verify             Verify option for Session (http://docs.python-requests.org/en/master/user/advanced/#ssl-cert-verification)
  --rate RATE          Delay between API calls (in seconds)
  --as_user            Pass true to delete the message as the authed user. Bot
                       users in this context are considered authed users.
  --message            Delete messages
  --file               Delete files
  --info               Show information
  --regex              Interpret channel, direct, group, and mpdirect as regex
  --channel CHANNEL    Channel name's, e.g., general
  --direct DIRECT      Direct message's name, e.g., sherry
  --group GROUP        Private group's name
  --mpdirect MPDIRECT  Multiparty direct message's name, e.g.,
                       sherry,james,johndoe
  --user USER          Delete messages/files from certain user
  --botname BOTNAME    Delete messages/files from certain bots. Implies '--bot'
  --bot                Delete messages from bots
  --keeppinned         exclude pinned messages from deletion
  --after AFTER        Delete messages/files newer than this time (YYYYMMDD)
  --before BEFORE      Delete messages/files older than this time (YYYYMMDD)
  --types TYPES        Delete files of a certain type, e.g., posts,pdfs
  --pattern PATTERN    Delete messages/files with specified pattern or if one of their attachments matches (regex)
  --perform            Perform the task

必要な権限の範囲

付与する権限は、スクリプトの使用目的によって異なります。用途に応じて以下の権限を付与してください。

権限を付与するだけでなく、このスクリプトを使用して他の人が投稿したメッセージやファイルを削除したい場合は、ワークスペースの所有者または管理者である必要があります。

パブリックチャネルからのメッセージの削除

channels:history
channels:read
chat:write (または古いアプリの場合はchat:write:userとchat:write:botの両方)
users:read

プライベートチャネルからのメッセージの削除

groups:history
groups:read
chat:write (古いアプリの場合はchat:write:user )
users:read

1:1 IM からのメッセージの削除

im:history
im:read
chat:write (古いアプリの場合はchat:write:user )
users:read

複数人の IM からのメッセージの削除

mpim:history
mpim:read
chat:write (古いアプリの場合はchat:write:user )
users:read

ファイルの削除

files:read
files:write (古いアプリの場合はfiles:write:user )
users:read

使用法

 # Delete all messages from a channel
slack-cleaner --token < TOKEN > --message --channel general --user " * "

# Delete all messages from a private group aka private channel
slack-cleaner --token < TOKEN > --message --group hr --user " * "

# Delete all messages from a direct message channel
slack-cleaner --token < TOKEN > --message --direct sherry --user johndoe

# Delete all messages from a multiparty direct message channel. Note that the
# list of usernames must contains yourself
slack-cleaner --token < TOKEN > --message --mpdirect sherry,james,johndoe --user " * "

# Delete all messages from certain user
slack-cleaner --token < TOKEN > --message --channel gossip --user johndoe

# Delete all messages from bots (especially flooding CI updates)
slack-cleaner --token < TOKEN > --message --channel auto-build --bot

# Delete all messages older than 2015/09/19
slack-cleaner --token < TOKEN > --message --channel general --user " * " --before 20150919

# Delete all files
slack-cleaner --token < TOKEN > --file --user " * "

# Delete all files from certain user
slack-cleaner --token < TOKEN > --file --user johndoe

# Delete all snippets and images
slack-cleaner --token < TOKEN > --file --types snippets,images

# Show information about users, channels:
slack-cleaner --token < TOKEN > --info

# Delete matching a regexp pattern
slack-cleaner --token < TOKEN > --pattern " (bar|foo.+) "

# TODO add add keep_pinned example, add quiet

# Always have a look at help message
slack-cleaner --help

アプリの設定

クリーナーでは、必要な操作を実行できるように Slack の API 権限を付与する必要があります。これらを付与するには、使用するワークスペースでアプリとして登録します。

次の方法でこれらの権限をアプリに付与できます。

あなたのアプリに行く
「新しいアプリの作成」を選択し、アプリ名（例：「Slack Cleaner」）を入力して、それを使用する Slack ワークスペースを選択します。
サイドバーで「OAuth と権限」を選択します
「スコープ」まで下にスクロールし、必要なスコープをすべて選択します
「変更を保存」を選択します
「アプリをワークスペースにインストール」を選択します
権限を確認して「承認」を押します
表示されている「OAuth アクセストークン」をコピーし、このトークンをスクリプトの--token引数として使用します。

ヒント

--logが指定されている場合、タスクの後、バックアップファイルslack-cleaner.<timestamp>.log現在のディレクトリに作成されます。

API の問題が発生した場合は、 --rate=<delay-in-seconds>を試して、API 呼び出し速度を下げてください (デフォルトでは無制限です)。

urllib3から次の警告が表示された場合は、不足しているパッケージをインストールすることを検討してください: pip install --upgrade requests[security]または、Python を 2.7.9 にアップグレードするだけです。

 InsecurePlatformWarning: A true SSLContext object is not available.
          This prevents urllib3 from configuring SSL appropriately and may cause certain SSL connections to fail.
          For more information, see https://urllib3.readthedocs.org/en/latest/security.html#insecureplatformwarning.