BotListBot

テレグラム @BotListBot

これは、Telegram BotList の保守を担当するチャットボットです。Telegram BotList は、Telegram 上で最高のボットを収集するためのコミュニティ主導のアプローチであるチャネルです。

このボットは、BotList のミラーとして機能することでナビゲーションを簡素化し、BotListChat コミュニティによるボットの送信、レビュー、公開のプロセスを自動化します。

このリポジトリは、ボット ビルダー、主に素晴らしい python-telegram-bot ライブラリを使用する人々へのインスピレーションと技術的なガイダンスを目的としています。

JosXa/BotListBot は MIT ライセンスに基づいてライセンスされています。

セットアップガイド

前提条件

必須

• Python 3.7.x
• PostgreSQL データベース インスタンスまたは Docker (以下を参照)
• Pipenv がグローバルにインストールされる ( pip install pipenv )
• ローカル開発用の独自のボット トークン

オプション

• Sentry.io アカウント (ロギング)
• S3 互換のオブジェクト ストレージ (例: Minio)

開発セットアップ

GitHub コードスペースと VSCode の使用 (推奨)

これが最も早く開始できるオプションであるため、お勧めします。

1. GitHub Codespaces で、「 JosXa/BotListBot 」と入力し、開発コンテナを作成します。
2. template.env内の変数を変更し、ファイルをチェックアウトのルート フォルダーに.envとして保存します。
3. pipenv run python -m botlistbot.main経由でプロジェクトを実行します。

PyCharmを使用して...

Docker を使用して PostgreSQL データベース インスタンスをセットアップする

1. Dockerをインストールする
2. docker-compose up -dを実行します
3. pipenv run python scripts/initialize_database.py seed
4. データベースを停止するには、 docker-compose down実行します。

BotListBot をセットアップする

1. VCS -> バージョン管理から取得... -> https://github.com/JosXa/BotListBot (または独自のフォーク)
2. Pipenv ( virtualenv ではない) を使用して新しいプロジェクト インタープリターを追加し、PyCharm にパッケージをインストールさせます
3. template.env内の変数を変更し、ファイルをルート フォルダーに.envとして保存します。
4. ファイルscripts/initialize_database.py 1 回実行します。次に、その実行構成を開き、引数リストに「シード」という単語を追加して、再度実行します。これにより、データベースにいくつかの必要な初期値が入力されます。
5. デフォルト設定を使用してbotlistbot/main.pyを実行します。

PyCharmを使用していない...

Docker を使用して PostgreSQL データベース インスタンスをセットアップする

1. Dockerをインストールする
2. docker-compose up -dを実行します
3. pipenv run python scripts/initialize_database.py seed
4. データベースを停止するには、 docker-compose down実行します。

BotListBot をセットアップする

1. GitHub からクローンを作成します: git clone https://github.com/JosXa/BotListBot (または独自のフォーク)
2. pipenv install実行する
3. template.env内の変数を変更し、ファイルをチェックアウトのルート フォルダーに.envとして保存します。
4. pipenv run python scripts/initialize_database.py seed
5. pipenv run python -m botlistbot.main経由でプロジェクトを実行します。

構成の詳細

settings.py を見ると、 decouple.config(...)呼び出しを通じて取得されている多数の環境変数がわかります。これらの設定は、ルート フォルダーに作成した.envファイルを介して制御できます。