kail4ek / pyproject-cookiecutter

Hi there 👋

Skills

Programming Languages

Machine learning frameworks

Python frameworks

OS

Git

Containers and clusters

Build

Other

Management

MLOps

Robotics frameworks

Hardware platforms

Databases

Frontend frameworks

Backend frameworks

IDEs

Github Statistics

pyproject-cookiecutter's Issues

Добавить опциональное создание папки docs

Чтобы складывать туда отчёты, заметки и прочую чебушню (=
Или как-то формализировать название папки под это

Поддержка python3.10

Убрать указание явных файлов и проверить

pyproject-cookiecutter/{{ cookiecutter.project_name }}/.pre-commit-config.yaml

Line 52 in 6613306

files: ^{{ cookiecutter.project_slug }}/

Добавить содержание в шаблон

Обновить typer

typer = "^0.9.0"
black = "^23.3.0"

Тогда можно поставить click = "^8.1.3"
safety ругался на уязвимость в клике версии 7

Добавить Python 3.11

Обновление формата формирования HTML из ноутбука

Недавно рассмотрели интересную опцию:
-poetry run jupyter nbconvert --template toc2 --to html_toc --output-dir ./exports <путь до файла>
+poetry run jupyter nbconvert --template toc2 --to html_embed --output-dir ./exports <путь до файла>

html_embed позволяет встроить картинки прямо в ноутбук вместо отдельной папки с ними. Надо будет подумать.

Ссылка на установку poetry для Windows - устарела

Должна быть в DEVELOPMENT.md

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

Добавить настройки для github репозитория

Подобному этому https://github.com/hassio-addons/hassio-vagrant/tree/master/.github

Добавить инфу про editorconfig для VSCode

https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig

Добавить поддержку GitLab

Добавить project-paths

Чуть пощупала штуку, мне понравилось
https://pypi.org/project/project-paths/

Добавить mkdocs (опционально)

mkdocs = "^1.4.2"
mkdocs-material = "^9.1.4"
mkdocstrings = "^0.20.0"
mkdocstrings-python = "^0.8.3"

Добавить хук для вытаскивания номера таски из имени ветки

Сделать также опциональный таргет в Makefile

Нужно поддержать следующие форматы и ожидаемые результаты: (ветка -> комит сообщение):
feature/1 -> [#1] ...
develop -> [develop] ...
hotfix/RP-23 -> [RP-23] ...
feature/4-bugfix-module -> [#4] ...
master -> [master] ...
hotfix/5 -> [#5] ...
bugfix/T-3 -> [T-3] ...
release/10 -> [#10] ...

Сейчас видится вопрос парсинга формата, так как GH хочет # для номеров issue, а Atlassian - просто названия из Jira.

Добавить пример фикстуры и conftest

Не хватает фреймворка для nbdime

Падает ошибка при make project-init

ModuleNotFoundError: No module named 'ipython_genutils'
make: *** [Makefile:40: tools-install] Error 1

Добавить python-dotenv пакет в шаблон

Для внедрения привычки использовать .env файлы добавить пакет и в .gitignore закинуть строку.

Добавить хук на большие файлы

https://github.com/pre-commit/pre-commit-hooks#check-added-large-files

Очистка pre-commit от хуков, которые явно меняют код

Сделать тесты в action для проверки работы

Обновить шаблон для poetry >= 1.7.0

Poetry хочет, чтобы были заполнены поля repository и homepage url-ами

Добавить опции в cookiecutter, чтобы включать тесты, пример конфига, ноутбуки и т.д.

Заменить argparse на click в шаблоне

Опечатка в README

Проверить шаблон с последней версией poetry

poetry v 1.2 происходят ошибки:

1. минимальная версия Питона прописана как ~3.8 и для питона 3.9 появляется ошибка не соответствия требованиям, если заменить на ^3.8 - то всё ок
2. на строку isort ... "^^5.3.10" в pyproject.toml поетри ругается, говорит что-то типа "не знаю такой синтаксис", если оставить одну крышечку "^5.3.10", то всё ок
3. в файле pre-commit-config.yaml poetry ругается на первые 2 строки (при более свежей версии питона)
   default_language_version:
   python: python3.8

Добавить таргет поиска TODO/NOTE

На примере этого

.PHONY: grep-todos
grep-todos:
	git grep -EIn "TODO|FIXME|XXX"

Обновить версию mypy

В шаблоне достаточно старая версия с багами, в новых версиях много чего исправили

Изменить ^ на ~ для версии питона

В шаблоне спрашивается какая версия питона нужна для проекта, но потом этот выбор можно сказать игнорируется

В pyproject.toml стоит ^ вместо ~, тогда если на компе есть несколько версий питона, то выбирается наибольшая, и если хочется, чтобы проект был с питоном 3.9, а на компе есть питон 3.10 , то окружение делается на базе питона 3.10

Добавить опции по выбору package менеджера

Нужно добавить опцию, чтобы можно было выбрать pip или poetry