Введение

PyFabricate — это приложение для Mac OS X, упрощающее создание проектов Python. Поскольку я написал его, очевидно, что это самоуверенная версия того, как, по моему мнению, должен выглядеть проект Python. Кроме того, у меня есть определенный набор инструментов, который я использую, чтобы писать приложения Python для Mac OS X. Тем не менее, я попытался внести некоторые изменения, представив шаблоны, на основе которых я создаю файлы проектов. Подробнее об этом позже.

Обзор

PyFabricate использует интерфейс, похожий на мастера, для запроса деталей проекта.

Упрямые предположения

• Разработчик использует HomeBrew для установки самоуверенных зависимостей.

  • Python управляется через pyenv (для использования в созданных виртуальных средах)
  • direnv установлен (необязательно)

• Название проекта совпадает с именем пакета модуля

Установка

Скачайте текущий выпуск отсюда.

Скопируйте этот файл в папку приложений Mac OS. Приложение подписано кодом Apple, поэтому вы получите простое сообщение, которое необходимо подтвердить при первом запуске.

Детали скелета проекта

Ниже приведен образец исходного скелета, созданного PyFabricator. Теперь он показывает виртуальную среду, которую он создает. Подробнее об этом позже.

По сути, PyFabricate создает каталоги src и тесты. В корневом каталоге проекта создаются следующие файлы:

• .envrc
• .gitignore
• .mypi.ini
• .python_version
• .ЛИЦЕНЗИЯ
• README.md
• pyproject.toml
• requirements.txt

Кроме того, PyFabricate создает все файлы пакета Python (__init__.py) во всех соответствующих местах. И, наконец, он помещает два набора файлов конфигурации журналирования: один для вашего приложения, а другой для ваших модульных тестов.

В конце изготовления PyFabricate создает виртуальную среду Python. Из-за технических ограничений PyFabricate не может использовать версию Python pyenv для создания виртуальной среды. Таким образом, это зависит от установленной версии homebrew.

Интерфейс мастера

Пользовательский интерфейс мастера представляет собой четырехэтапный процесс, в ходе которого PyFabricate собирает достаточную информацию о проекте, которую он использует для заполнения скелетных шаблонов. В шаблонах используются следующие понятные токены замены.

Ниже приведено аннотированное изображение шаблона Pyroject.toml.

Пользовательский интерфейс мастера, шаг 1. Введение

Этот шаг представляет собой введение в PyFabricate. После этого шага PyFabricate делает все возможное, чтобы обеспечить соблюдение зависимостей выполнения. В противном случае разработчик не сможет продолжить этот шаг.

Пользовательский интерфейс мастера, шаг 2. Подробности проекта

На этом этапе PyFabricate собирает информацию, специфичную для проекта. Большая часть этого служит для заполнения шаблона pyproject.toml.

Пользовательский интерфейс мастера, шаг 3 – базовый каталог

PyFabricate предполагает, что разработчик хранит все свои проекты Python в одном подкаталоге. Это самоуверенное мнение и просто предпочтение организации.

Пользовательский интерфейс мастера, шаг 4 – версия Python

PyFabricate запрашивает pyenv для версий Python, установленных разработчиком. Это единственные, с помощью которых PyFabricate может создавать виртуальные среды Python.

Журнал действий

В конце работы мастера PyFabricate представляет журнал создания проекта. Ниже приведен пример журнала.

Кастомизация

Как упоминалось ранее, разработчик может настроить некоторые аспекты генерации проекта. PyFabricate хранит используемые шаблоны в $HOME/.config/pyfabricate/templates, как указано ниже.

Например, разработчик может захотеть использовать другую лицензию. Просто замените файл LICENSE.template

Заворачивать

PyFabricate в настоящее время существует только в версии 0.5.0. В настоящее время я изучаю возможность добавления дополнительных функций и снятия ограничений.