Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MarkdownFile-creater (GCP Enterprise Vertex AI 対応)

GCP Enterprise環境において、API Keyを使用せず、IAM / Application Default Credentials (ADC) を用いてVertex AI (Gemini) からMarkdownドキュメントを安全に生成するPythonツールです。

特徴

  • 🔒 API Key非使用: 情報漏洩リスクのあるAPI Keyを要求・使用しません。
  • 🏢 Enterprise Ready: GCP IAM / サービスアカウント / ADC 認証を標準サポート。
  • 📄 Markdown生成: 高品質で構造化されたMarkdownドキュメントをコマンドラインから即座に作成。
  • 🛠 認証診断機能: --check-auth フラグでGCP接続状態を簡単にチェック可能。

事前準備(認証設定)

ローカル環境で実行する場合は、事前に gcloud CLI でログインしてください:

gcloud auth application-default login

環境変数でGCPプロジェクトを指定することも可能です:

export GOOGLE_CLOUD_PROJECT="your-gcp-project-id"
export LOCATION="us-central1"

または .env ファイルに記述してください。

インストール

pip install -r requirements.txt

使い方

1. GCP接続・認証テスト

python main.py --check-auth

2. Markdownドキュメントの生成

python main.py --prompt "マイクロサービス構成図を含む技術仕様書のテンプレートを作成してください" --output "spec.md"

動作テスト手順

本アプリケーションの正常動作およびGCP認証状態を確認するための動作テスト手順です。

1. 依存関係と構文の確認

依存ライブラリをインストールし、Pythonスクリプトの構文チェックを行います。

pip install -r requirements.txt
python -m py_compile main.py vertex_client.py config.py

2. GCP認証(ADC)およびVertex AI接続テスト

GCPのIAM権限および認証状態が正常であるか接続テストを実行します。

python main.py --check-auth

成功時の表示例:

🔍 GCP Vertex AI 接続診断を実行中...
  ・Project ID : your-gcp-project-id
  ・Location   : us-central1
  ・Model      : gemini-1.5-flash
  ・Auth Mode  : IAM / ADC (API Key不使用)

⚡ 接続テスト用リクエストを送信中...
✅ 接続テスト成功!
   レスポンス: Hello from GCP Enterprise Vertex AI

3. Markdownドキュメント生成テスト

実際にプロンプトを指定してMarkdownファイルが正常に生成・出力されるか確認します。

python main.py --prompt "テスト用の簡単なシステム構成案を作成してください" --output "test_output.md"

実行後、test_output.md が作成され、適切なMarkdown構造で保存されているか確認します。

4. エラーハンドリング確認(任意)

認証情報が未設定の状態で実行した場合、適切な対処手順(gcloud auth application-default login の案内)が表示されることを確認します。

About

PDF-Fileなどから、Markdownfileを作成

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages