dynaconf

特徴

• 12-factor アプリケーション ガイドからインスピレーションを得た
• 設定管理 (デフォルト値、検証、解析、テンプレート化)
• 機密情報の保護 (パスワード/トークン)
• 複数のファイル形式toml|yaml|json|ini|pyおよびカスタマイズ可能なローダー。
• 既存の設定をオーバーライドする環境変数の完全なサポート (dotenv サポートを含む)。
• マルチ環境向けのオプションの階層化システム[default, development, testing, production]
• 設定およびシークレット ストレージとして Hashicorp Vault および Redis のサポートが組み込まれています。
• DjangoおよびFlask Web フレームワークの組み込み拡張機能。
• init, list, write, validate, exportなどの一般的な操作用の CLI。
• 完全なドキュメントは https://dynaconf.com にあります

インストール

$ pip install dynaconf

プロジェクトのルート ディレクトリで Dynaconf を初期化する

 $ cd path/to/your/project/

$ dynaconf init -f toml

  Configuring your Dynaconf environment
------------------------------------------
? The file `config.py` was generated.

?️  settings.toml created to hold your settings.

? .secrets.toml created to hold your secrets.

? the .secrets.* is also included in `.gitignore`
  beware to not push your secrets to a public repo.

? Dynaconf is configured! read more on https://dynaconf.com

ヒント: dynaconf init -f <fileformat>でtoml|yaml|json|ini|py選択できます。tomlはデフォルトであり、構成に最も推奨される形式でもあります。

Dynaconf init は次のファイルを作成します

 .
├── config.py       # This is from where you import your settings object (required)
├── .secrets.toml   # This is to hold sensitive data like passwords and tokens (optional)
└── settings.toml   # This is to hold your application settings (optional)

ファイルconfig.py上で、Dynaconf init は次の定型文を生成します。

 from dynaconf import Dynaconf

settings = Dynaconf (
    envvar_prefix = "DYNACONF" ,  # export envvars with `export DYNACONF_FOO=bar`.
    settings_files = [ 'settings.yaml' , '.secrets.yaml' ],  # Load files in the given order.
)

ヒント:上記のようにinitコマンドを使用する代わりにファイルを自分で作成でき、デフォルトのconfig.pyの代わりに任意の名前を付けることができます (ファイルはインポート可能な Python パスに存在する必要があります) - 使用できるその他のオプションを参照してください。 https://dynaconf.com のDynaconfクラス初期化子に渡します

Dynaconf の使用

設定をsettings.{toml|yaml|ini|json|py}に置きます。

 username = " admin "
port = 5555
database = { name = ' mydb ' , schema = ' main ' }

機密情報を.secrets.{toml|yaml|ini|json|py}に置く

 password = " secret123 "

重要: dynaconf initコマンドは、パブリック リポジトリでの公開を避けるために.gitignoreに.secrets.*を配置しますが、それをローカル環境で安全に保管するのはユーザーの責任です。また、運用環境では、ビルドされたパスワードとトークンの Hashicorp Vault サービスのサポート。

オプションで、環境変数を使用して、実行ごとまたは環境ごとに値をオーバーライドできるようになりました。

 # override `port` from settings.toml file and automatically casts as `int` value.
export DYNACONF_PORT=9900

コードでsettingsオブジェクトをインポートします

 from path . to . project . config import settings

# Reading the settings

settings . username == "admin"  # dot notation with multi nesting support
settings . PORT == 9900  # case insensitive
settings [ 'password' ] == "secret123"  # dict like access
settings . get ( "nonexisting" , "default value" )  # Default values just like a dict
settings . databases . name == "mydb"  # Nested key traversing
settings [ 'databases.schema' ] == "main"  # Nested key traversing 

もっと

• 設定スキーマの検証
• カスタム設定ローダー
• ボールトサービス
• テンプレートの置換
• 等...

他にもできることはたくさんあります。ドキュメントを読んでください: http://dynaconf.com

貢献する

主なディスカッションは「ディスカッション」タブで行われます。参加方法の詳細については、CONTRIBUTING.md ガイドをご覧ください。

もっと

Rust プロジェクトで使用する Dynaconf に似たものを探している場合: https://github.com/rubik/hydroconf

そして、ロゴを提供してくれたCanecoに特別な感謝を捧げます。