python_repository_simple

本リポジトリはシンプルな Python 環境のテンプレートリポジトリです devcontainer の設定をしていますので、VS Code と Docker、Git さえあれば各種開発用設定が行われた Python の開発環境が構築され、即時開発が可能です GitHub のリポジトリページの「Use this template」を押下して使用してください

内容

• devcontainer
• uv
  • ruff
• Pylance, pyright
• hadolint
• pytest
• GitHub Actions
• logging

環境詳細

• Python : 3.13

事前準備

• Docker インストール
• VS Code インストール
• VS Code の拡張機能「Remote - Containers」インストール
  • https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers
• 本リポジトリの clone
• ssh-agent の設定
  • https://code.visualstudio.com/docs/devcontainers/containers#_using-a-credential-helper
• 以下をプロジェクト名に合わせて変更
  • .devcontainer/devcontainer.json
    • name
  • compose.yaml
    • image, container_name
    • env_file
      • 環境変数を使用しない場合は除去
  • main.py
  • logging.conf
    • hoge を使用するモジュール名に合わせる
  • README.md
  • LICENSE
  • dependabot
    • .github/dependabot.yml
    • .github/workflows/auto_merge_depandabot.yml
  • pyproject.toml
    • project.name, project.description, project.authors, tool.hatch.build.targets.wheel

開発手順

1. VS Code 起動
2. 左下のアイコンクリック
3. 「Dev Containers: Reopen in Container」クリック
4. しばらく待つ
   • 初回の場合コンテナー image の取得や作成が行われる
5. 起動したら開発可能
   • 初回起動時は uv sync を実行してください

NOTE

• 実行
  • uv run main.py
• ユニットテスト
  • uv run python -m pytest
    • uvx pytest の設定もしているが、uv 環境で実装されないため、上記コマンドで実行する
• lint
  • uvx ruff check
  • uvx ruff check --fix
• format
  • uvx ruff format
  • uvx ruff format --check
• 本番での依存ライブラリインストール
  • uv sync --no-dev