Скачать cookie - скачать исходный код cookie

cookie

AI Исходный код

2024.08.19

Скачать

Scientific Python: Guide, Cookie, & Sp-Repo-Review

Печенье

Шаблон Copier/CookieCutter для новых проектов Python на основе научного руководства по разработчику Python. Что отличает это от других шаблонов для пакетов Python?

Живет с руководством по развитию научного питона: каждое решение четко задокументировано, и каждый описанный инструмент, и все хранится синхронизировать.
Девять различных бэкэнд на выбор для строительных пакетов.
Необязательное управление версией VCS для большинства бэкэндов.
Генерация шаблонов проверяется в действиях GitHub с использованием NOx.
Поддерживает генерацию с помощью копира, кусочка и Cruft.
Поддерживает действия GitHub, если нацеливание на URL -адрес github.com (по умолчанию), и добавляет экспериментальную поддержку Gitlab CI иначе.
Включает несколько скомпилированных бэкэнд с использованием Pybind11, с колесами, производимыми для всех платформ с использованием Cibuildwheel.
Предоставляет sp-repo-review для оценки существующих репо с руководящими принципами, с версией WebAssembly, интегрированной с руководством. Все чеки сшиты.
Следует за лучшими практиками PYPA и регулярно обновляется.

Убедитесь, что вы сначала прочитали Руководство по развитию научного питона и, возможно, использовали их в проекте или два. Это не минимальный пример или учебник. Это набор полезных инструментов для запуска нового проекта с использованием CookieCutter или для копирования в отдельных файлах для существующего проекта (вручную, от {{cookiecutter.project_name}}/ ).

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

Хэтч: это использует хэтллинг, современный строитель с хорошим включением файла, расширяемые через плагины и хорошие сообщения об ошибках. (Рекомендуется для проектов Pure Python)
FLIT: современная, легкая система сборки PEP 621 для проектов Pure Python. Заменяет setuptools, без Manifest.in, setup.py или setup.cfg. Низкая кривая обучения. Легко начать садиться на новые дистрибутивы. Трудно получить правильные файлы, небольшая динамическая поддержка метаданных.
PDM: Современное, менее самоуверенное решение для проектов Pure Python, поддерживающих стандарты. Заменяет Setuptools, Venv/Pipenv, Pip, колеса и шпагат. Поддерживает PEP 621.
Поэзия: все в одном решение для Pure Python Projects. Заменяет Setuptools, Venv/Pipenv, Pip, колеса и шпагат. Высшая кривая обучения, но все в одном. Делает несколько плохих предположений по умолчанию для библиотек. Единственный с нестандартным конфигурацией pyproject.toml.
Setuptools: классическая система сборки, но с новой стандартизированной конфигурацией.
Pybind11: это Setuptools, но с расширением C ++, написанным на Pybind11 и колесах, генерируемых Cibuildwheel.
Scikit-Build: проект Scikit-Build (CMAKE) также с использованием Pybind11 с использованием Scikit-Build-Core. (Рекомендуется для проектов C ++)
Meson-Python: проект Meson также с использованием Pybind11. (Нет VCS -версии)
Матурин: застройщик PEP 621 для ржавчины бинарные расширения. (Нет VCS -версии) (рекомендуется для проектов ржавчины)

В настоящее время лучший выбор, вероятно, является люк для проектов Pure Python и Scikit-Build (например, выбор Scikit-Build-Core + Pybind11) для бинарных проектов.

Использовать (современная версия копирования)

Установите copier и copier-templates-extensions . Используя PIPX, это:

pipx install copier
pipx inject copier copier-templates-extensions

Теперь запустите Copier, чтобы создать свой проект:

copier copy gh:scientific-python/cookie < pkg > --trust

( <pkg> -это путь для размещения нового проекта. Если копир старый, используйте --UNSAFE вместо --trust )

Вы получите более приятный опыт CLI с проверкой ответов. Вы также получите файл .copier-answers.yml , который позволит вам выполнять обновления в будущем.

Примечание: добавить --vcs-ref=HEAD чтобы получить последнюю версию вместо последней версии с тегами; Голова всегда проходит тесты (и это то, что использует CookieCutter).

Использовать (классическая версия CookieCutter)

Установите CookieCutter, в идеале с помощью brew install cookiecutter если вы используете Brew, в противном случае с pipx install cookiecutter (или pipx run к команде ниже, и пропустите установку). Затем беги:

cookiecutter gh:scientific-python/cookie

Если вы используете CookieCutter 2.2.3+, вы получите хорошие описания для таких вариантов, как Copier!

Использовать (классическая версия Cruft)

Вы также можете использовать Cruft, который добавляет обновление возможности для проектов CookieCutter. Установите с помощью pipx install cruft (или pipx run к команде ниже, и пропустите установку). Затем беги:

cruft create gh:scientific-python/cookie

Пост -поколение

Проверьте файлы настройки ключей, pyproject.toml и, возможно, setup.cfg и setup.py (пример Pybind11). Обновление README.md . Также обновите и добавьте документы в docs/ .

Есть несколько примеров зависимостей и минимальная версия Python 3.9, не стесняйтесь изменить ее на все, что вам нужно/нужно. Существует также базовая структура закупорочных ресурсов с небольшим примером печати.

Содержали компоненты:

Действия GitHub выполняют тестирование для самого поколения
- Использует NOX, чтобы разработка файлов cookie можно было проверить локально
Действия GitHub развернуты
- C ++ Backends включают Cibuildwheel для сборки колес
- Использует развертывание PYPI Trusted Publisher
Devideabot периодически поддерживает действия, посредством полезных запросов на притяжение
Форматирование, обрабатываемое предварительным
- Нет причин не быть строгим в новом проекте; Удалите то, что вы не хотите.
- Включает Mypy - статическое набор
- Включает езрок - стандартное форматирование, лининг и автофиксы
  - Заменяет Flake8, Isort, Pyupgrade, Yesqa, Pycln и десятки плагинов
- Включает проверку заклинаний
Цель Pylint NOX может использоваться для запуска Pylint, которые интегрировали аннотации GHA
Подготовленная папка Docs Docs Readthedocs и [docs] Extra
Тестовая папка и Pytest [test] дополнительный
NOXFILE включен с несколькими общими целями

Для разработчиков:

Вы можете проверить локально с NOx:

# See all commands
nox -l

# Run a specific check
nox -s "lint(scikit-build)"

# Run a noxfile command on the project noxfile
nox -s "nox(hatch)" -- docs

Если у вас нет nox локально, вы можете использовать PIPX, например, pipx run nox .

Другие подобные проекты

Hypermoderner-Python-это еще один проект, который стоит проверить со многими сходствами, такими как отличная документация для каждой функции и многие из тех же используемых инструментов. Он имеет немного другой набор функций и более сильнее сосредоточен на действиях GitHub - большинство нашего руководства может быть адаптировано к другой системе CI довольно легко, если вы не хотите использовать GHA. Это также заставляет использовать поэзию (вместо того, чтобы иметь бэкэнд -выбор), и не поддерживает скомпилированные проекты. В настоящее время он сбрасывает все зависимости развития в общую среду, вызывая длительные времена и высокие шансы на конфликты. Он также не использует предварительную связь так, как было предназначено для использования. У этого также есть немало пользовательского кода.

История

Многие руководства, CookieCutter и Repo-Review начинались как часть Scikit-HEP. Эти проекты были объединены, обобщены и в сочетании с руководством NSLS-II на саммите разработчиков научных питонов 2023 года.

SP-Repo-Review

sp-repo-review предоставляет проверки, основанные на Руководстве по разработке научного питона в Scientific-Python/Cookie для Repo-Review.

Этот инструмент может проверить стиль репозитория. Используйте так:

pipx run ' sp-repo-review[cli] ' < path to repository >

Это даст список результатов - зеленые чеки означают, что это правило соблюдается, Red x означает, что правило нет. Желтый предупреждающий знак означает, что чек был пропущен, потому что предыдущая необходимая проверка не удалась. Некоторые чеки потерпят неудачу, это нормально - цель состоит в том, чтобы довести все возможное для вашего внимания, а не привести к соблюдению произвольных проверок. В конце концов может быть способ отметить чеки, которые игнорируются.

Например, GH101 ожидает, что все ваши файлы действий получит хорошее name: поле. Если вы довольны именами на основе файлов, которые вы видите в CI, вы должны просто игнорировать эту проверку (просто визуально игнорируйте его на данный момент, способ указать игнорируемые проверки, вероятно, будет добавлен в конечном итоге).

Все чеки упоминаются, по крайней мере, в некотором смысле в Руководстве по развитию научного питона. Сначала вы должны прочитать это - если вы не пытаетесь следовать за ними, некоторые проверки могут не сработать. Например, руководящие принципы указывают, что конфигурация Pytest будет размещена в pyproject.toml . Если вы разместите его в другом месте, то все проверки Pytest будут пропущены.

Первоначально это было разработано для Scikit-HEP, прежде чем переехать на научный питон.

Другие способы использования

Вы также можете использовать действия GitHub:

- uses : scientific-python/cookie@<version>

Или предварительная коммерция:

- repo : https://github.com/scientific-python/cookie
  rev : <version>
  hooks :
    - id : sp-repo-review

Если вы используете additional_dependencies для добавления большего количества плагинов, таких как validate-pyproject , вы также должны включить "repo-review[cli]" , чтобы обеспечить включение требований CLI.