Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/273do/openai-api-with-google-docs

Google Docsでプロンプトを管理し，PythonでOpenAI APIを使用するためのテンプレートです．
https://github.com/273do/openai-api-with-google-docs

docker google-docs openai-api python

Last synced: 8 days ago
JSON representation

Google Docsでプロンプトを管理し，PythonでOpenAI APIを使用するためのテンプレートです．

Awesome Lists containing this project

README 

        
# OpenAI API with Google Docs



本リポジトリは，Google Docs でプロンプトを管理する方法し，Python で OpenAI API を使用するためのテンプレートです．



## 🤖 開発環境・使用技術・ツール



環境，コード管理



 Docker

 Python

 GitHub

Git




外部サービス



 Google Docs

 OpenAI API




## 🤖 環境構築・起動



> 環境構築について記載しています．



環境構築



1. `Git` と `Docker Desktop` をインストールしてください．

2. 任意のディレクトリで`git clone https://github.com/273Do/OpenAI-API-with-Google-Docs`を実行してください．

3. `Dockerfile`があるディレクトリ(ルート)に移動します．

4. 移動したディレクトリに`.env`ファイルと`service_account`ディレクトリを作成します．



5. `.env`ファイルに以下を記載してください．



   > OPENAI_API_KEY=

   >

   > DOCUMENT_ID=



6. [こちらの記事](https://mashimashi.net/skill/821)を参考に，Google Cloud Platform にアクセスして，**Google Drive API** と **Google Docs API** を有効化し，認証情報(json ファイル)をダウンロードしてください．

7. ダウンロードした認証情報を`credential.json`とファイル名を変更して，`service_account`ディレクトリに移動させます．

8. Google Drive に 専用テンプレートをコピーし，ドキュメントの URL を取得してください．(テンプレートについては開発者にお問い合わせください．)

9. 取得した URL`https://docs.google.com/document/d/`の``の部分を控えてください．

10. `.env`ファイルに OpenAI API の API キーと控えた DOCUMENT_ID を記載してください．

11. ファイル構成を確認してください．



```

 📁openai-api-with-google-docs

 └── 📁service_account

     └── credential.json

 └── .env

 └── .gitignore

 └── app.py

 └── docker-compose.yml

 └── Dockerfile

 └── README.md

 └── requirements.txt

```



12. `Docker Desktop`を起動して，`Dockerfile`があるディレクトリ(ルート)に移動します．

13. `docker compose build`を実行してコンテナイメージを作成します．



> [!CAUTION]

> .env ファイルと認証情報は絶対に公開しないでください．

>

> 



> 起動方法と終了方法について記載しています．



起動方法と終了方法



### 起動方法



1. `Docker Desktop`を起動します．

2. `docker-compose.yml`があるディレクトリ(ルート)に移動します．

3. `docker compose up -d`を実行してコンテナを起動します．(もしくは`Docker Desktop`のコンテナ起動ボタンを押します．)

4. `docker compose exec openai-api-with-google-docs bash`でコンテナの中に入ります．

5. `python3 app.py`でコードが実行できます．



### 終了方法



1. コンテナに入っている場合は`exit`で抜けられます．

2. `docker compose down`を実行してコンテナを終了します．(もしくは`Docker Desktop`のコンテナ終了ボタンを押します．)



> [!TIP]

> コンテナイメージを作成したら，以降は以下の手順でコンテナを起動するだけで OK です.

> 新たにライブラリや依存関係をインストールする場合は，`requirements.txt`にライブラリを記載して`docker compose build`を実行します．



## 🤖 クレジット・免責事項



- 開発：[273\*](https://www.273doworks.com/)

- この作成物および同梱物を使用したことによって生じたすべての障害・損害・不具合等に関しては，私と私の関係者および私の所属するいかなる団体・組織とも，一切の責任を負いません．各自の責任においてご使用ください．