環境変数のやつ

概要

• python-dotenv のメモです。

インストール

普通にインストールします。

$ pip install python-dotenv

サンプルコード

例えばこんなのを用意します。

import os

from dotenv import load_dotenv


load_dotenv()

hoge = os.environ['HOGE']
print(hoge)

HOGE が環境変数です。 だいたいこういう環境変数には DB との接続情報とかそういう環境ごとに変わるしなんならリポジトリで公開したくない情報を入れたりします。

ここで適当に

$ export HOGE=hoge

のようにコマンドを叩いて都度設定も良いかもしれませんが、.env というファイルを用意して次のような内容を書きます。

HOGE=fuga

これであとは実行するだけのこの .env ファイルから環境変数を読み込んでくれます。

オトナな使い方

サンプルとして（定義すべき環境変数の一覧を伝える意味でも） sample.env みたいな名前のファイルを用意して README.md に以下のコマンドを実行してくれと書くのが一般的です。

$ cp sample.env .env

そのうえで .gitignore ファイルには .env と書いておくのが一般的だと思います。