Программа курса Урок 240 из 250 · Итоговый проект: Отправка (Упаковка вашего проекта)
Итоговый проект: Отправка (Упаковка вашего проекта)

Структура репозитория

Вы создали что-то реальное в предыдущих финальных проектах: помощника для поддержки, экстрактор документов, шлюз оценки. Сейчас это, вероятно, лежит кучей ячеек или одним длинным скриптом. Менеджер по найму, который открывает это, должен guess где находятся элементы, а рекрутер, который клонирует его и не видит очевидного способа запуска, просто закрывает вкладку. Самое эффективное, что вы можете сделать для портфолио проекта, это дать ему скучная, общепринятая структура чтобы любой мог сориентироваться за 30 секунд.

Честный комментарий сразу: этот модуль посвящен repo, а не развертыванию в облаке. Мы не можем запустить сервер или отправить данные на хост из вашего браузера, и мы не будем делать вид, что можем. То, что вы can можете изучить и доказать здесь, это структура, тесты и запуск одной командой, которые делают развертывание простым позже. Заметки по развертыванию в конце это именно это -> заметки, помеченные как не оцениваемые.

Структура, к которой сводится почти каждый проект на Python:

my_project/
  README.md            # what it is + how to run it
  pyproject.toml       # name, version, dependencies
  .env.example         # the shape of the secrets (NEVER the real ones)
  src/
    my_project/        # the importable package
      __init__.py
      __main__.py      # runs on `python -m my_project`
      core.py          # your actual code
  tests/
    test_my_project.py # pytest finds these by the test_ prefix

Две вещи стоит заметить. Во-первых, пакет находится в src/ в папке названной по имени проекта -> это и есть "src layout", и это не дает вашим тестам случайно импортировать локальную папку вместо установленного пакета. Во-вторых, имя директории пакета отслеживает имя проекта: проект под названием triage получает src/triage/, проект под названием copilot получает src/copilot/. Нет единого запечатанный ответ -> дерево является функцией от имени.

Ваша задача написать эту функцию. build_manifest(name) принимает имя проекта и возвращает список файлов которые должен содержать репозиторий в виде sorted списка строк путей. Он должен включать README.md, pyproject.toml, директорию пакета под src/<name>/ содержащую __init__.py и файл модуля, а также файл tests/test_*.py. Нормализуйте имя в валидную директорию пакета (строчные буквы, замените пробелы и дефисы на подчеркивания, так как doc-extractor не является импортируемым именем модуля, а doc_extractor является).

Это манифест, который создал бы скрипт развертывания на диске. Мы не записываем файлы в грейдер -> мы проверяем, что вы можете описать правильное дерево для любого имени проекта. Нажмите Run, чтобы вывести структуру для проекта под названием triage.

Твоя очередь

Напишите build_manifest(name), который возвращает дерево файлов репозитория для проекта как sorted список строк пути. Он должен включать README.md, pyproject.toml, директорию пакета под src/<pkg>/ с __init__.py, __main__.py (этот файл делает python -m <pkg>, команду запуска в уроке 3, работающим) и как минимум один другой файл модуля .py, и тестовый файл с именем tests/test_<pkg>.py. Нормализуйте name в директорию пакета (строчные буквы, пробелы и дефисы становятся подчеркиваниями), чтобы разное имя проекта давало разное дерево.

Заметили проблему в этом уроке? Сообщите о ней · Спросить об этом уроке

Это упражнение откроется скоро

Закончи предыдущий урок, чтобы открылся этот. Весь курс бесплатный, аккаунт не нужен, и ты можешь прочитать этот урок прямо сейчас.