Модули в python

Для того чтобы ваш модуль можно было установить через команду pip install, вам нужно сделать следующее:

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

 mymodule/ 
    mymodule/ 
        __init__.py 
        module_file.py 
    setup.py 
    README.md 
    LICENSE 
    .gitignore 
 

Файл setup.py:
Создайте файл setup.py в корне вашего проекта с таким содержимым:

 from setuptools import setup, find_packages 
 
with open("README.md", "r", encoding="utf-8") as fh: 
    long_description = fh.read() 
 
setup( 
    name="mymodule", 
    version="0.1.0", 
    author="Your Name", 
    author_email="your.email@example.com", 
    description="A short description of the project", 
    long_description=long_description, 
    long_description_content_type="text/markdown", 
    url="https://github.com/yourusername/mymodule", 
    packages=find_packages(), 
    classifiers=[ 
        "Programming Language :: Python :: 3", 
        "License :: OSI Approved :: MIT License", 
        "Operating System :: OS Independent", 
    ], 
    python_requires='>=3.6', 
) 
 

Файл README.md:
Создайте файл README.md с описанием вашего проекта. Это поможет пользователям понять, что делает ваш модуль.

Лицензия:
Выберите и добавьте файл с лицензией, например LICENSE. Самая популярная - MIT License.

Создание дистрибутива:
Убедитесь, что у вас установлены setuptools и wheel. Выполните команду:

 python -m pip install --upgrade setuptools wheel 
 

Затем создайте дистрибутив вашего пакета:

 python setup.py sdist bdist_wheel 
 

Регистрация на PyPI:
Зарегистрируйтесь на PyPI (если еще не сделали этого) по этой ссылке.

Загрузка пакета на PyPI:
Убедитесь, что у вас установлен twine. Выполните команду:

 python -m pip install --upgrade twine 
 

Затем загрузите пакет на PyPI:

 python -m twine upload dist/* 
 

Вас попросят ввести ваш логин и пароль от PyPI.