Repolode
theskumar

theskumar/python-dotenv

12-factor appの考え方に沿って、.envファイルのキーと値を環境変数に読み込むPythonライブラリです。

スター
8,916
フォーク
619
未解決の Issue
126
最終コミット
10 日前

これは何?

python-dotenvは.envファイルからキーと値を読み込み、環境変数として設定します。環境から設定を取得する12-factor app向けに作られており、開発時にはシェルで毎回exportしなくても、設定をローカルファイルに保持できます。

主なエントリーポイントはload_dotenv()です。デフォルトでは.envファイルを探し、その値をos.environに追加します。override=Trueを指定しない限り、既存の環境変数は変更されません。dotenv_values()は環境変数に触れず、解析した値をdictで返します。どちらの関数も、ファイルの代わりにストリームから読み込めます。また、dotenvコマンドラインツールを使うと、ファイルの変数を読み込んだ状態で、値の設定や一覧表示、コマンドの実行ができます。

ファイル形式はBashに似ており、引用符、コメント、exportプレフィックス、複数行の値、${VAR}による展開に対応しています。パッケージはpipでインストールでき、IPython拡張機能も含まれています。

主な機能

  • 01.envファイルの値をos.environに読み込みます。デフォルトでは既存の環境変数を上書きしません。
  • 02dotenv_values()を使い、環境変数を変更せずに解析した値をdictで取得できます。
  • 03ファイルだけでなく、ストリームからも設定を読み込めます。
  • 04引用符、コメント、exportプレフィックス、複数行の値を含むBash風の構文に対応しています。
  • 05値の中に記述された${VAR}形式の変数を展開します。
  • 06読み込んだ変数を使って、値の設定や一覧表示、コマンドの実行ができるdotenv CLIを備えています。
  • 07IPythonで.envファイルを読み込むための拡張機能を提供します。

ユースケース

  • Python製Webアプリの開発中に、データベースURLやAPIキーをローカルの.envファイルに保持する。
  • ネットワークストリームなど、ファイルシステム以外からPythonプログラムに設定を読み込む。
  • dotenv runコマンドを使い、.envファイルの変数を設定した状態でスクリプトを実行する。
  • os.environを変更せず、設定のマージに使う.envの値をdictとして読み込む。

クイックスタート

  1. 1

    PyPIからライブラリをインストールします

    pip install python-dotenv
  2. 2

    プロジェクトのルートに設定を記述した.envファイルを作成します

  3. 3

    アプリケーションの起動時にload_dotenv()を呼び出します

使う前に知っておきたいこと

  • .envファイルの形式は正式に規定されておらず、今後変更される可能性があります。

トピック

よくある質問

python-dotenv とは?
12-factor appの考え方に沿って、.envファイルのキーと値を環境変数に読み込むPythonライブラリです。 python-dotenvは.envファイルからキーと値を読み込み、環境変数として設定します。環境から設定を取得する12-factor app向けに作られており、開発時にはシェルで毎回exportしなくても、設定をローカルファイルに保持できます。
python-dotenv は無料で使えますか?ライセンスは?
python-dotenv は BSD-3-Clause ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
python-dotenv は今もメンテナンスされていますか?
活発にメンテナンス中。python-dotenv の最終コミットは 2026年10月28日 です。
python-dotenv は何に使えますか?
Python製Webアプリの開発中に、データベースURLやAPIキーをローカルの.envファイルに保持する。 ネットワークストリームなど、ファイルシステム以外からPythonプログラムに設定を読み込む。 dotenv runコマンドを使い、.envファイルの変数を設定した状態でスクリプトを実行する。 os.environを変更せず、設定のマージに使う.envの値をdictとして読み込む。
python-dotenv のインストール方法は?
PyPIからライブラリをインストールします: pip install python-dotenv プロジェクトのルートに設定を記述した.envファイルを作成します アプリケーションの起動時にload_dotenv()を呼び出します
python-dotenv はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/theskumar/python-dotenv

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト