Обучение
January 24, 2020
Добавление модуля в PyPI
Для начала создадим в папке проекта файлы
setup.py LICENSE README.md {module_name}/ {module_name}/__init__.py {module_name}/{package_name}.py
{module_name}/{package_name}.py
это ваш основной файл со всем кодом.
Создать всё это можно командами:
mkdir {module_name} touch {module_name}/__init__.py setup.py LICENSE README.md {module_name}/{package_name}.py
В {package_name} находится весь ваш код.
Редактируем setup.py:
import setuptools with open("README.md", "r") as fh: long_description = fh.read() setuptools.setup( name="{module_name}", version="0.0.1", author="Автор", author_email="имэйл автора", description="Короткое описание", long_description=long_description, # длинное описание в файле readme.md long_description_content_type="text/markdown", url="ссылка на репозиторий проекта", packages=setuptools.find_packages(), classifiers=[ "Programming Language :: Python :: 3", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", ], python_requires='>=3.6', )
Теперь сделаем длинное описание в файле README.md, как это сделать можно посмотреть здесь.
# Example Package This is a simple example package. You can use [Github-flavored Markdown](https://guides.github.com/features/mastering-markdown/) to write your content.
Выбор лицензии. Вы можете посмотреть лицензии здесь.
Я выбираю лицензию MIT.
MIT License Copyright (c) {year} {fullname} Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Обновляем нужные пакеты
python3 -m pip install --user --upgrade setuptools wheel
Собираем пакет
python3 setup.py sdist bdist_wheel
Отправка
Регистрируемся на PyPI, получаем и сохраняем токен здесь.
И отправляем пакет на сервер
twine upload dist/*
Вводим в качестве логина __token__
и в пароль ваш токен (вместе с pypi)
Пробуем установить командой
pip install {module_name}
Запускаем
from {module_name} import {package_name}