Типичные улучшения

Для поиска по тегу начните название тега с символа '@'.

Улучшения, показаны 50 из 59.

Разделите конфиги docker compose для разных окружений

Разделение конфигураций Docker Compose для разных окружений имеет несколько преимуществ: 1. **Гибкость и переносимость**: Разделение …

Используйте UPPER_CASE для переменных окружения

Так исторически сложилось, что переменные окружения принято называть в верхнем регистре с символом подчеркивания: не …

Изолируйте функцию от внешнего окружения

С функциями, которые берут свои настройки из переменных окружения сложно работать. Прочитайте объявление такой функции …

Соберите переменные окружения в settings.py

Когда другой программист захочет развернуть проект, то первым делом он пойдёт искать переменные окружения в …

Расскажите в README о переменных окружения

Программа берет настройки из нестандартных переменных окружения. Их не угадать без чтения кода.

Используйте UPPER_CASE для переменных окружения

Так исторически сложилось, что переменные окружения принято называть в верхнем регистре с символом подчеркивания: не …

Изолируйте функцию от внешнего окружения

С функциями, которые берут свои настройки из переменных окружения сложно работать. Прочитайте объявление такой функции …

Добавьте DB к названию переменной окружения

По названию переменной сложно догадаться, что речь идёт о настройках базы данных. Обычно используют префикс …

Запустите сайт из виртуального окружения

Почему-то на сервере все зависимости Python поставлены на уровне системы вместо виртуального окружения. Это помешает …

Разделите конфиги docker compose для разных окружений

Как для запуска приложения в local-окружении на машине разработчика, так и на серверах вам понадобятся …

Разверните скрипт в новом вирт.окружении

Программа не запускается, что-то не то с зависимостями.

Соберите переменные окружения в settings.py

Когда другой программист захочет развернуть проект, то первым делом он пойдёт искать переменные окружения в …

Расскажите в README о переменных окружения

Программа берет настройки из нестандартных переменных окружения. Их не угадать без чтения кода.

Добавить окружения в READMY

Добавить окружения в READMY

Перенесите загрузку переменных окружения внутрь ifmain / def main

Функция `load_dotenv` меняет настройки окружения, общие для всей программы. Такой код нельзя размещать на уровне …

Добавьте DB к названию переменной окружения

По названию переменной сложно догадаться, что речь идёт о настройках базы данных. Обычно используют префикс …

Разбейте профиль на отдельные настройки

Профили настроек вроде `production`, `test` или `development` для настроек -- это хоть и популярная, но …

Запустите сайт из виртуального окружения

Почему-то на сервере все зависимости Python поставлены на уровне системы вместо виртуального окружения. Это помешает …

Разрешите пользователю указать другой путь к файлу

Зачастую пользователи хранят данные отдельно от программ. И тогда либо программа позволит указать нестандартный путь …

Дайте токену специфичное название

Со временем в дополнение к одному API может понадобиться подключение еще нескольких. У них каждого …

Создать .env и использовать в docker-compose по назначению

Создать .env и использовать в docker-compose по назначению

Спрячьте SECRET_KEY

В файле settings.py есть настройка `SECRET_KEY` — это секретный ключ, с помощью которого шифруют пароли …

Вынесите настройку DEBUG

В файле settings.py есть настройка `DEBUG`, она включает отладочный режим работы сайта. На локальной машине …

Вынесите конфиг из кода

На то есть сразу несколько причин. Во-первых, пользователи не хотят лезть в код. А во-вторых, …

Почините настройку DEBUG

Любое непустое значение в переменной окружения включает отладочный режим, даже если это `DEBUG=FALSE`.

Вынесите chat_id из кода

Сейчас настройка `chat_id` намертво зашита в скрипте и без правок в коде её никак не …

Добавьте в README инструкции по установке

При чтении документации пользователя прежде всего интересует как установить программу.

Спрячьте чувствительные данные

Не стоит хранить в коде токены, секретные ключи и прочие пароли. Код рано или поздно …

Требуйте меньше настроек CLI

Сейчас ваш проект очень муторно разворачивается: вы **требуете** от пользователя прописать кучу настроек для первого …

Вынесите настройку ALLOWED_HOSTS

В файле settings.py есть настройка `ALLOWED_HOSTS`, она нужна для безопасности вашего сайта, защищает вас от …

Отключите DEBUG на продакшн-версии сайта

Сейчас ваш сайт запущен как бы "в режиме продакшна", но у сайта включен дебаг. Из-за …

Дайте токену специфичное название

Со временем в дополнение к одному API может понадобиться подключение еще нескольких. У них каждого …

Удалите пробелы из примера .env

В вашем README есть пример заполнения файла с конфигами. Дело в том, что так их …

Почините ALLOWED_HOSTS

В чём тогда смысл настройки, если в ней лежат домены, которые вам не принадлежат? Она …

Добавьте файл с зависимостями

Без точных инструкций установка программы превращается в головную боль.

Уменьшите кол-во необходимых библиотек

Программисты регулярно читают и редактируют файл requirements.txt. Чем меньше в нем записей, тем проще разобраться.

Зафиксируйте версии пакетов

Когда через полгода выйдут новые версии библиотек с приятными плюшками и обратно несовместимыми изменениями, установка …

Спрячьте SECRET_KEY

В файле settings.py есть настройка `SECRET_KEY` — это секретный ключ, с помощью которого шифруют пароли …

Вынесите настройку DEBUG

В файле settings.py есть настройка `DEBUG`, она включает отладочный режим работы сайта. На локальной машине …

Почините настройку DEBUG

Любое непустое значение в переменной окружения включает отладочный режим, даже если это `DEBUG=FALSE`.

Разбейте документацию на разделы

Когда в документации один текст, тратится много времени на прочтение, чтобы узнать, например, как установить …

Вынесите chat_id из кода

Сейчас настройка `chat_id` намертво зашита в скрипте и без правок в коде её никак не …

Возьмите настройки из django.conf.settings

Импорт настроек проекта напрямую из файла `settings.py` ломает механизм конфигурации Django. Проблем здесь сразу несколько. …

Упакуйте настройки доступа к БД в один URL

Если вы считываете настройки доступа к БД из переменных окружения, то выглядеть такой код может …

Перепроверьте инструкции в документации

Инструкции в документации неполны либо содержат ошибки. Возможно, инструкции просто устарели со временем. Воспринимайте инструкции …

Переопределите SECRET_KEY

В файле settings.py есть настройка `SECRET_KEY` — это секретный ключ, с помощью которого шифруют пароли …

Используйте в названиях правильный регистр букв

Верхний и нижний регистр букв в названиях имеют значение. По ним программист узнает тип сущности: …

Перенесите canvas.nodelay в код инициализации

```python canvas.nodelay(True) ``` Этот код поменяет настройки canvas для всей программы разом и сломает остальной …

Очистите функции

В программировании есть такое понятие — *чистая функция*. От прочих она отличается тем, что не …