Как отправить посылку в PyPi?


Я написал небольшой модуль, и я хотел бы знать, каковы основные шаги, чтобы упаковать его, чтобы отправить его в pypi:

  • Что такое файловая иерархия?
  • Как я должен называть файлы?
  • должен ли я использовать distutils для создания PKG-INFO?
  • куда я должен включить свою документацию (сделанную с помощью sphinx)?
4 15

4 ответа:

Рекомендую читать руководство автостопщика по упаковке. В частности, вы должны посмотреть на Краткое руководство раздел, в котором описывается, как:

  1. изложите свой проект
  2. опишите свой проект
  3. создайте свой первый релиз
  4. зарегистрируйте пакет с помощью индекса пакета Python (PyPI)
  5. загрузите свой релиз, затем возьмите полотенце и спасите Вселенную!

Ты следует также посмотреть на текущее состояние упаковки в городе Введение в упаковку раздел , поскольку это помогает распутать некоторые путаницы, окружающие setuptools, distutils, distutils2 и distribute.

Update Re: Как называть файлы

Ниже приведен отрывок из PEP8, который отвечает на ваш вопрос о том, как называть файлы:

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

Поскольку имена модулей сопоставляются с именами файлов, а некоторые файловые системы нечувствительны к регистру и усекают длинные имена, важно, чтобы имена модулей были достаточно короткими-это не будет проблемой в Unix, но это может быть проблемой, когда код переносится на более старые версии Mac или Windows или DOS.

Пример всегда лучший способ увидеть, как это сделать:

Http://packages.python.org/an_example_pypi_project/

Может быть, этот сырный магазин вам поможет. Оттуда:

Отправка пакетов в пакет Индекс

Если у вас есть некоторые модули или пакеты Python, которые вы хотели бы поделитесь с сообществом Python, мы хотели бы, чтобы они были включены в индекс пакета Python! Во-первых, если вы еще не сделали этого, вы захотите чтобы организовать ваш проект. Вы можете следовать рекомендациям по адресу ProjectFileAndDirectoryLayout. После этого вам захочется почитать то Документация Python по созданию дистрибутивов: http://docs.python.org/distutils/index.html .

Вы также можете проверить написание пакета на Python Тареком Зиаде из книги Тарека "Expert Python Programming", где вопросы разработки и распространения рассматриваются очень подробно

Ответ Мэтью Рэнкина рассказывает вам, как организовать файл проекта heirarchy, но мне приходится искать команды для выполнения каждый раз, когда я хочу обновить проект на PyPI. Итак, вот они:

Как описано на сайте PyPi :