Makefiles и классификаторы

Разработка пакетов на Python

James Fulton

Climate informatics researcher

Классификаторы

Метаданные пакета
Помогают пользователям найти пакет на PyPI
Рекомендуется указать
- Статус пакета
- Целевая аудитория
- Тип лицензии
- Язык
- Поддерживаемые версии Python
Полный список классификаторов: https://pypi.org/classifiers

Файл setup.py пакета mysklearn

setup(
    ...
    classifiers=[
        'Development Status :: 2 - Pre-Alpha',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Natural Language :: English',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
    ],
    ...
)

Для чего нужны Makefiles?

Используются для автоматизации сборки пакета

mysklearn/
...
|-- README.md
|-- setup.py
|-- Makefile  <---
...

Что содержит Makefile?

Файл Makefile

...

dist: ## builds source and wheel package
    python3 setup.py sdist bdist_wheel


clean-build: ## remove build artifacts
    rm -fr build/
    rm -fr dist/
    rm -fr .eggs/


test: ## run tests quickly with the default Python
    pytest


release: dist ## package and upload a release
    twine upload dist/*

Как использовать Makefile?

make <function-name>

mysklearn/ <--- navigate to here
...
|-- README.md
|-- setup.py
|-- Makefile  
...

Как использовать Makefile?

Чтобы вызвать функцию dist, введите в терминале

make dist

Файл Makefile

...

dist: ## builds source and wheel package
    python3 setup.py sdist bdist_wheel

clean-build: ## remove build artifacts
    rm -fr build/
    rm -fr dist/
    rm -fr .eggs/

test: ## run tests quickly with the default Python
    pytest

release: dist ## package and upload a release
    twine upload dist/*

Обзор Makefile

make help

clean                remove all build, test, coverage and Python artifacts
clean-build          remove build artifacts
clean-pyc            remove Python file artifacts
clean-test           remove test and coverage artifacts
lint                 check style with flake8
test                 run tests quickly with the default Python
test-all             run tests on every Python version with tox
release              package and upload a release
dist                 builds source and wheel package
install              install the package to the active Python's site-packages

Давайте потренируемся!

Разработка пакетов на Python