Общие требования к Python-пакету при сдаче проекта
Исходный текст пакета должен храниться в публичном репозитории (крайне желателен Git, хостинг любой)
В состав репозитория должны входить формальные указание по сборке wheel-пакета (как минимум, pyproject.toml)
Пакет должен устанавливаться и работать из этого .wheel-файла
- Если для начала работы с пакетом требуются дополнительные действия (получение ключа, настройка СУБД и т. п.), они должны быть описаны в документации
- Всё API пакета должно быть документировано
Желательно использовать Sphinx + sphinx-apidoc
- Должна присутствовать пользовательская документация (примеры использования и краткое описание)
Желательно использовать Sphinx + публикацию на ReadTheDocs
…но можно воспользоваться wiki вашего хостинга, или даже аккуратно оформить дерево .md-файлов прямо в репозитории
- Пакет должен быть снабжён компонентными тестами (желательно, но необязательно, 100% покрытие)