Skip to content
/ python_project_template Public template

This is a template for creating a project with python.

License

MIT license
2 stars 2 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

eycjur/python_project_template

BranchesTags

Repository files navigation

Python Project Template

pythonでプロジェクトを作成する際のテンプレートです。

About

本リポジトリは、PythonでWebアプリケーションを開発する際のテンプレートです。

サンプルとして、メッセージ管理アプリケーションを実装しています。

ユースケース図

ユースケース図

機能要件

機能 詳細 ユースケース
メッセージの登録 メッセージを登録する メッセージ登録
メッセージの閲覧 メッセージを閲覧する メッセージ閲覧

画面遷移図

画面遷移図

API仕様(FastAPI)

メソッド パス 説明
GET /messages メッセージ一覧を取得
POST /messages メッセージを登録

Features

以下の機能を提供しています。

  • UI
    • CLI(typer)
    • API(FastAPI)
    • サーバーサイドレンダリング(Flask)
    • UIフレームワーク(streamlit, dash)
  • データベース
    • SQLite
    • Firestore
    • DynamoDB
    • CosmosDB
  • クラウド
    • GCP(Cloud Run)
    • AWS(App Runner, Lambda)
    • Azure(Container Apps)
  • CI/CD
    • GitHub Actions
  • テスト
    • unit test
    • e2e test
  • ログ
  • モニタリング

Architecture

Onion Architectureを採用しています。

UIフレームワークによって詳細は異なりますが、FastAPIを利用する場合のアーキテクチャ図を以下に示します。

アーキテクチャ図(FastAPI)

Initialize Project

プロジェクトを初期化する際は、以下の手順で行ってください。

  1. このリポジトリをクローン
  2. .env.sampleを元に.envを作成
  3. 不要なファイルを削除

Minimize Project

本リポジトリは、各種クラウドでの動作確認等を行うため、最小限+αの構成としています。
最小限の構成として利用する場合は、以下の手順で不要なファイルを削除してください。

  1. make minimizeを実行
  2. docker-compose.ymlからcredentialsのマウントを削除
  3. src/presentation/のサブディレクトリのうち、不要なフレームワークのディレクトリを削除
  4. .devcontainer/devcontainer.jsonのlaunchの設定のうち、不要なフレームワークの設定を削除
  5. README.mdを編集
  6. クラウド関係の環境変数を.envとsrc/settings.pyから削除

Run Application

アプリケーションを実行する際は、以下の手順で行ってください。

  1. make upでDocker Composeを起動
  2. http://localhost:<LOCAL_PORT>/ からアプリにアクセス
  3. make downでDocker Composeを終了
    終了せずにDev Containerを起動すると、docker-compose.override.ymlの内容が上書きされずデバッグが利用できません。

Development

アプリケーションの開発を行う際は、以下の手順で行ってください。

  1. pre-commitをインストール(ex. pip install pre-commit)
  2. pre-commit installでpre-commitのhookスクリプトを導入
  3. VSCodeでDev Container拡張機能をインストール
  4. コマンドパレット(Ctrl+Shift+P)からRemote-Containers: Reopen in Containerを実行
  5. (Docker Compose立ち上げ時のみ)拡張機能の依存関係の解決に失敗することがあるので、ウィンドウの再読み込みする
  6. F5でデバッグ実行が可能
  7. http://localhost:<LOCAL_PORT>/ からアプリにアクセス

FastAPI

FastAPIを利用する場合は、以下の手順で行ってください。

  1. 上記手順でAPIサーバーを起動
  2. live-server拡張機能で、src/presentation/fastapi/frontend/index.htmlを開く
  3. http://localhost:5500/src/presentation/fastapi/frontend/ からフロントエンドにアクセス

Deploy

各クラウドへのデプロイを行う際は、以下の手順で行ってください。

GCP

前準備

  1. Terraform State用のGCSバケット作成
    • Cloud Storage > バケット の画面から、terraform-state保存用のGCSバケット（ex. <app_name>-terraform-state-bucket）を作成
      保存場所やストレージクラスは任意、公開アクセスの防止はオンを選択

Terraformコマンドの実行

make create-infra-gcp

後処理

  1. サービスアカウントキーの発行
    • IAMと管理 > サービスアカウント > 作成したサービスアカウント > キー の画面から、 鍵を追加 > 新しい鍵の作成 > JSON > 作成 で鍵を作成してダウンロード
    • credentials/credential_gcp.jsonとして保存
  2. ドメインの発行
    • Cloud Domains > ドメインを登録 からドメインを発行
    • DNSはterraformで作成したCloud DNSのゾーンを指定
  3. SSL証明書のプロビジョニング
    • セキュリティ > Certificate Manager > 従来の証明書 の画面からステータスが完了になるまで待つ
  4. makeコマンドでデプロイ
    • make deploy-gcpコマンドを実行すると、アプリケーションのデプロイが行われます
  5. 通知チャンネルの作成
    • Monitoring > アラート > EDIT NOTIFICATION CHANNELS から、Emailの通知チャンネルを作成
    • アラートポリシーを編集し、作成した通知チャンネルを追加

リソースの削除

make destroy-gcp

AWS App Runner

前準備

  1. Terraform State用のS3バケット作成
    • Amazon S3 > バケットを作成 の画面から、terraform-state保存用のS3バケット（ex. <app_name>-terraform-state-bucket）を作成
      バケットタイプは汎用、ACLは無効、パブリックアクセスはブロック、バージョニングは無効、暗号化はS3マネージドキーを選択

Terraformコマンドの実行

make create-infra-aws-apprunner

後処理

  1. credentialsをcredentials/credentials_awsとして保存
    ユーザーアカウントを利用する場合はcp ~/.aws/credentials credentials/credentials_awsとしてください
  2. make deploy-aws-apprunnerでApp Runnerにデプロイ

リソースの削除

make destroy-aws-apprunner

AWS Lambda

前準備

  1. Terraform State用のS3バケット作成
    • Amazon S3 > バケットを作成 の画面から、terraform-state保存用のS3バケット（ex. <app_name>-terraform-state-bucket）を作成
      バケットタイプは汎用、ACLは無効、パブリックアクセスはブロック、バージョニングは無効、暗号化はS3マネージドキーを選択

Terraformコマンドの実行

make create-infra-aws-lambda

後処理

  1. credentialsをcredentials/credentials_awsとして保存
    ユーザーアカウントを利用する場合はcp ~/.aws/credentials credentials/credentials_awsとしてください
  2. make deploy-aws-lambdaでLambdaにデプロイ

リソースの削除

make destroy-aws-lambda

Azure

Container Appsへのデプロイを実施します

  1. Entra IDのアプリを登録からサービスプリンシパルを登録し、クライアントシークレットを発行する
  2. .envのAZURE_CLIENT_ID,AZURE_CLIENT_SECRETに各値を設定
  3. CosmosDBのデータベースとコレクションを作成
  4. サービスプリンシパルにCosmosDBへのアクセス権の付与 
    az cosmosdb sql role assignment create \
--account-name <CosmosDBのアカウント名> \
--resource-group <リソースグループ名> \
--scope "/" \
--principal-id <EntraIDのエンタープライズアプリケーションの該当アプリケーション（サービスプリンシパル）のオブジェクトID> \
--role-definition-id <ロールid=00000000-0000-0000-0000-000000000002>
    cf. https://learn.microsoft.com/ja-jp/azure/cosmos-db/how-to-setup-rbac
  5. make deploy-azureでContainer Appsにデプロイ
  6. (オプション)Application Insightsを作成
  7. (オプション)Application Insightsなどの監視/ログからアラートを設定
    cf. https://yotiky.hatenablog.com/entry/azure_exceptionsalert

About

This is a template for creating a project with python.

Topics

python project-template

Resources

Readme

License

MIT license
Activity

Stars

2 stars

Watchers

1 watching

Forks

2 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages