backend-template-python

開発の進め方

1. プロジェクト作成方法に従ってプロジェクトを作成する
2. Toolsのうち、必要なツールをインストール
3. 実装方法に従って開発を進める

プロジェクト作成方法

GUI

右上の Use this template からレポジトリを作成できます。

Tools

エディタ(必須)

エディタはVSCode、もしくはそのフォークであるCursorを推奨しています。

拡張機能として、Dev Containersをインストールしてください。

参考: DevContainerを使ってみよう

Docker(必須)

公式ページ DevContainerを立ち上げるために必要です。

インストール方法はこちらを参考にしてください。

uv(DevContainerに内包)

# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

ref: uv documentation

Python(DevContainerに内包)

uv python install {version}

How to run

DevContainerを立ち上げると8080番ポートでサーバーが立ち上がります。 http://localhost:8080/ (API)

DevContainerを使わず手動で立ち上げたい場合、以下のコマンドを使用してください。

docker build -t backend_python . && docker run --rm -p 8080:8080 backend_python

format

uv run ruff format .

linter check

ruff check . --fix

Acknowledgements

This project is based on a5chin/python-uv, which is licensed under the MIT License.