> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Python で Square Cloud を始める

> Python で Square Cloud を始める方法を学びましょう

## 🚀 はじめに

* 始める前に、システムに Python がインストールされていることを確認してください。まだお持ちでない場合は、[Python 公式サイト](https://www.python.org/)からダウンロードできます。
* 次に、Square Cloud のアカウントを作成する必要があります。これは[ログインページ](https://squarecloud.app/ja/signup)から行えます。アカウントの作成にはメール、GitHub、またはその両方を使用できます。
* 最後に、アカウントで有効な有料プランが必要です。プランの確認とニーズに応じた購入は[こちら](https://squarecloud.app/ja/pricing)から行えます。

## ⚙️ squarecloud.app ファイルの設定

<Note>
  Square Cloud のウェブサイト経由でアプリケーションをアップロードする場合は、このセクションを無視してかまいません。サイトが自動的に `squarecloud.app` 設定ファイルを作成します。
</Note>

<Card title="詳しく見る: Square Cloud の設定ファイルの作成方法" icon="link" href="https://docs.squarecloud.app/ja/getting-started/config-file">
  squarecloud.app ファイルは、アプリケーションを設定するために使用される設定ファイルです。名前、説明、
  バージョン、メインファイルなどを定義するために使われます。
</Card>

## 📄 必要なファイル

* 設定ファイルに `START` フィールドが定義されていない場合、Square Cloud は `python MAIN` を実行して `MAIN` で指定された Python ファイルを起動します。設定ファイルに `START` フィールドが定義されている場合は、その値が直接実行されます。設定ファイルのパラメータについての詳細は、[設定パラメータ](https://docs.squarecloud.app/ja/getting-started/config-file#configuration-parameters)をご覧ください。

* Square Cloud は `pip install` を使用して、`requirements.txt` に記載されているすべての依存関係をインストールします。

## 🖥️ プロジェクトの準備

### 📁 必須の設定ファイル

Python プロジェクトを Square Cloud にデプロイする準備をする際は、設定ファイル（`squarecloud.app/.config`）とアプリケーションの必須ファイルを zip ファイルに含めるようにしてください。

<Warning>設定ファイル（`squarecloud.app/.config`）は zip ファイルのルートに配置する必要があります。そうでない場合、Square Cloud はデプロイ時にそれを見つけることができません。</Warning>

#### 🗑️ アップロード前に除外するファイル

* `ffmpeg`: このソフトウェアは Square Cloud 環境にプリインストールされているため、プロジェクトに含める必要はありません。
* `.venv`: このフォルダにはプロジェクトの仮想環境が含まれています。Square Cloud は独立した環境を提供するため、このフォルダをアップロードする必要はありません。
* `poetry.lock`: Square Cloud は現在 Poetry をサポートしていないため、デプロイ時の互換性の問題を避けるためにこのファイルは除外してください。

### 🤔 なぜこれらのファイルを除外するのか？

`ffmpeg`、`.venv`、`poetry.lock` を除外することは、いくつかの理由で重要です:

1. **クリーンな環境:** Square Cloud はプロジェクト用に新しい環境を作成します。これらのファイルを含めることは不要であり、クラウド環境の設定と競合する可能性があります。

2. **効率性:** これらのファイルを削除するとアップロードサイズが小さくなり、プロセスがより速く軽量になります。

3. **互換性:** Square Cloud は依存関係のインストールに `requirements.txt` を使用するため、`poetry.lock` を除外することで互換性の問題を回避できます。

アップロードする前に、上記の不要なファイルを除外して、プロジェクトファイルを **.zip** 形式に圧縮してください。これにより、Python アプリケーションが Square Cloud で正常にデプロイできる状態になります。

### 📄 必要なファイル

* main.py（メインファイルの例）。
* [requirements.txt](./how-to-create-your-requirements)（依存関係ファイル）。
* または \[pyproject.toml]（依存関係ファイル）。
* [squarecloud.app](https://docs.squarecloud.app/ja/getting-started/config-file)（Square Cloud の設定を含むファイル）。

## 💡 トラブルシューティング

<AccordionGroup>
  <Accordion title="メインファイルが無効または破損しています" icon="file" iconType="solid">
    このエラーは、設定ファイルでアプリケーションの「main」として定義されたファイルが
    存在しない、記述が誤っている、またはパスが正しくない場合に発生します。
    メインファイルがフォルダ内にある場合は、例えば `folder/file.py` のように指定してください。
  </Accordion>

  <Accordion title="メモリ不足" icon="memory" iconType="solid">
    ボットをホストするために必要な RAM の最小量は 256MB、
    サイト/API の場合は 512MB です。ただし、アプリケーションのサイズや複雑さに応じて、
    アプリケーションがメモリ不足でクラッシュするのを避けるために、
    より多くの RAM を割り当てることをお勧めする場合があります。
  </Accordion>
</AccordionGroup>

## 📤 プロジェクトのホスト方法

これで Python プロジェクトのすべてのファイルを準備できたので、次のステップはそれらを Square Cloud にアップロードしてアプリケーションをオンラインにすることです。アップロードには複数の方法がありますが、ここでは Dashboard 経由と CLI 経由の 2 つを取り上げます。

### ダッシュボード経由

<Steps>
  <Step title="アップロードページにアクセス">
    [アップロードページ](https://squarecloud.app/ja/dashboard/new)にアクセスし、プロジェクトの zip ファイルをアップロードします。
  </Step>

  <Step title="環境を設定">
    zip をアップロードした後、プロジェクトの名前、メインファイルまたはランタイム環境、その他の設定を構成する必要があります。\
    ウェブプロジェクトをアップロードする場合は、必ず「Web Publication」を選択し、プロジェクトにサブドメインを設定してください。
  </Step>

  <Step title="プロジェクトをデプロイ">
    最後に「Deploy」ボタンをクリックして、プロジェクトを Square Cloud にホストします。\
    デプロイ後、ダッシュボードからプロジェクトのステータスとログを監視できます。

    <Frame>
      <img src="https://cdn.squarecloud.app/docs/articles/dashboard/uploading.gif" alt="Square Cloud へのアプリケーションのアップロード" style={{ borderRadius: "0.2rem" }} />
    </Frame>
  </Step>
</Steps>

### CLI 経由

この方法を使用するには、プロジェクトのルートディレクトリに `squarecloud.app` という名前の設定ファイルを作成する必要があります。このファイルには、プロジェクトに必要な設定が含まれます。

<Card title="詳細はこちら: Square Cloud の設定ファイルの作成方法。" icon="link" href="/ja/getting-started/config-file">
  squarecloud.app ファイルはアプリケーションを構成するために使用される設定ファイルであり、環境を定義するために使用されます。
</Card>

<Steps>
  <Step title="CLI をインストール">
    まず、環境に CLI がインストールされている必要があります。まだの場合は、ターミナルで次のコマンドを実行してください:

    ```
    npm install -g @squarecloud/cli
    ```

    すでにお持ちの場合は、更新することを推奨します。更新するには、ターミナルで次のコマンドを実行してください:

    <Tabs>
      <Tab title="Windows">
        ```bash theme={null}
        squarecloud update
        ```
      </Tab>

      <Tab title="Linux, macOS, and WSL">
        ```bash theme={null}
        curl -fsSL https://cli.squarecloud.app/install | bash
        ```
      </Tab>
    </Tabs>
  </Step>

  <Step title="認証">
    次に、認証して他の CLI コマンドを使用するには、[こちら](https://squarecloud.app/ja/account/security)で「Request API Key」をクリックして認証キーを取得します。認証キーを取得したら、次のコマンドを実行してください:

    ```bash theme={null}
    squarecloud auth login
    ```
  </Step>

  <Step title="プロジェクトをアップロード">
    最後に、CLI を使用してアプリケーションを Square Cloud にデプロイするには、次のコマンドを実行する必要があります:

    ```bash theme={null}
    squarecloud upload 
    ```

    または、zip を手動で作成した場合は、次を使用できます:

    ```bash theme={null}
    squarecloud upload --file <path/to/zip> 
    ```
  </Step>
</Steps>

## お問い合わせ

**技術的な問題**が解決しない場合は、**専門のサポートチーム**がお手伝いします。[**お問い合わせ**](https://squarecloud.app/ja/support)いただければ、どのような問題でも喜んで解決をサポートいたします。