Merge pull request #2 from cmscom/devin/1737123359-enhance-readme-docs

READMEの改善と開発環境の整備

Author: terapyon

README.md

@@ -1,2 +1,36 @@
 # demo-ai-django-pyhack
-AIでDjangoでPyHackの申し込みをやってみる
+
+AIでDjangoでPyHackの申し込みをやってみるプロジェクトです。
+
+## 環境構築
+
+### 必要条件
+- Python 3.12以上
+- pip (最新版推奨)
+
+### セットアップ手順
+1. リポジトリをクローン:
+   ```bash
+   git clone https://github.com/cmscom/demo-ai-django-pyhack.git
+   cd demo-ai-django-pyhack
+   ```
+
+2. 開発用パッケージをインストール:
+   ```bash
+   pip install -e ".[dev]"
+   ```
+
+## 開発
+
+### コードスタイル
+コードの品質チェックとスタイル整形には以下のコマンドを実行:
+
+#### Ruffによるコード品質チェック
+```bash
+ruff check .
+```
+
+#### インポート順序の整理（isort）
+```bash
+isort .
+```

pyproject.toml

@@ -7,3 +7,45 @@ requires-python = ">=3.12"
 dependencies = [
     "django>=5.1.5",
 ]
+
+[project.optional-dependencies]
+dev = [
+    "ruff>=0.3.0",
+    "isort>=5.0.0"
+]
+
+[tool.ruff]
+# Enable pycodestyle (`E`) and Pyflakes (`F`) codes by default.
+select = ["E", "F"]
+# Allow autofix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "venv",
+]
+# Same as Black.
+line-length = 88
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+# Target Python 3.12.
+target-version = "py312"