Repolode
theskumar

theskumar/python-dotenv

Библиотека Python загружает пары «ключ—значение» из файла .env в переменные окружения и следует принципам 12-factor app.

Звёзды
8,916
Форки
619
Открытые issues
126
Последний коммит
10 дней назад

Что это?

python-dotenv читает пары «ключ—значение» из файла .env и задаёт их как переменные окружения. Библиотека предназначена для приложений, следующих принципам 12-factor app и получающих конфигурацию из окружения: во время разработки настройки можно хранить в локальном файле, не экспортируя их каждый раз в shell.

Основная точка входа — load_dotenv(): по умолчанию она ищет файл .env, добавляет его значения в os.environ и не меняет уже заданные переменные, если не передать override=True. dotenv_values() возвращает разобранные значения в виде dict, не затрагивая окружение; обе функции могут читать данные из потока, а не только из файла. Утилита командной строки dotenv позволяет задавать и просматривать переменные, а также запускать команды с переменными, загруженными из файла.

Формат файла похож на Bash и поддерживает кавычки, комментарии, префикс export, многострочные значения и подстановку ${VAR}. Пакет можно установить через pip; в него также входит расширение для IPython.

Ключевые возможности

  • 01Загружает значения из файла .env в os.environ и по умолчанию не перезаписывает существующие переменные.
  • 02Возвращает разобранные значения в виде dict с помощью dotenv_values(), не меняя окружение.
  • 03Читает конфигурацию как из потоков, так и из файлов.
  • 04Поддерживает синтаксис, похожий на Bash: кавычки, комментарии, префикс export и многострочные значения.
  • 05Подставляет переменные, записанные в значениях в формате ${VAR}.
  • 06Включает CLI dotenv для задания и просмотра переменных, а также запуска команд с загруженными переменными.
  • 07Предоставляет расширение для IPython, которое загружает файлы .env.

Сценарии использования

  • Хранение URL баз данных и API-ключей веб-приложения на Python в локальном файле .env во время разработки.
  • Загрузка конфигурации из источника, не связанного с файловой системой, например сетевого потока, в программу на Python.
  • Запуск скрипта с переменными из файла .env с помощью команды dotenv run.
  • Чтение значений из .env в dict для объединения конфигураций без изменения os.environ.

Быстрый старт

  1. 1

    Установите библиотеку из PyPI

    pip install python-dotenv
  2. 2

    Создайте файл .env в корне проекта и укажите в нем настройки

  3. 3

    Вызовите load_dotenv() в начале работы приложения

Что важно знать

  • Формат файла .env официально не специфицирован и может со временем измениться.

Темы

Частые вопросы

Что такое python-dotenv?
Библиотека Python загружает пары «ключ—значение» из файла .env в переменные окружения и следует принципам 12-factor app. python-dotenv читает пары «ключ—значение» из файла .env и задаёт их как переменные окружения. Библиотека предназначена для приложений, следующих принципам 12-factor app и получающих конфигурацию из окружения: во время разработки настройки можно хранить в локальном файле, не экспортируя их каждый раз в shell.
python-dotenv можно использовать бесплатно? Какая у него лицензия?
python-dotenv распространяется с открытым исходным кодом под лицензией BSD-3-Clause. Перед использованием в коммерческих продуктах проверьте условия лицензии.
python-dotenv всё ещё поддерживается?
Активно поддерживается. Последний коммит в python-dotenv — 28 окт. 2026 г..
Для чего можно использовать python-dotenv?
Хранение URL баз данных и API-ключей веб-приложения на Python в локальном файле .env во время разработки. Загрузка конфигурации из источника, не связанного с файловой системой, например сетевого потока, в программу на Python. Запуск скрипта с переменными из файла .env с помощью команды dotenv run. Чтение значений из .env в dict для объединения конфигураций без изменения os.environ.
Как установить python-dotenv?
Установите библиотеку из PyPI: pip install python-dotenv Создайте файл .env в корне проекта и укажите в нем настройки Вызовите load_dotenv() в начале работы приложения
Где скачать python-dotenv?
Исходный код и инструкции по установке — на GitHub: https://github.com/theskumar/python-dotenv

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты