setuptools

setuptools
Name	setuptools
Author	Python Packaging Authority
Released	2004
Latest release	(varies)
Programming language	Python
Operating system	Cross-platform
License	MIT License

setuptools

setuptools is a Python library that enhances package development, distribution, and installation. It builds on Python (programming language)'s import and packaging mechanisms to provide tools for declaring package metadata, resolving dependencies, and creating distributable archives. Maintained by contributors associated with the Python Packaging Authority and influenced by projects like distutils and pip (software), setuptools has been central to many packaging workflows across GitHub, PyPI, and corporate codebases.

History

setuptools originated in the early 2000s as developers sought to extend distutils after challenges linking to projects such as Zope and Plone. Early work by individuals associated with Ian Bicking and collaborations with the Python Software Foundation community produced mechanisms for entry points and package discovery used by Paste (web framework) and Twisted. Over time, influences from packaging efforts like PEP 345 and PEP 427 informed setuptools' evolution, while interactions with pip (software) maintainers and the Python Packaging Authority guided compatibility and deprecation decisions. Major ecosystem events such as the adoption of wheels in the wake of PEP 427 and transitions driven by PEP 517 shaped setuptools' role alongside tools like wheel (package format), virtualenv, and tox.

Features

setuptools provides automated dependency resolution declarations, entry point registration, and easy creation of source and binary distributions. It implements support for features popularized in packaging proposals including metadata fields used in PEP 566 and wheel building aligned with PEP 427. Core features include: - Entry points enabling plugin systems used by projects like pytest, Sphinx (software), Flask extensions, and Celery (software). - Automatic package discovery and namespace package support used by large projects such as Google-sponsored libraries and community projects like Requests (software). - Integration hooks that interact with build front ends defined in PEP 517 and adapters used by pip (software) and build (Python package). setuptools also supports command customization invoked by tools and CI services like Jenkins, Travis CI, and GitLab CI/CD.

Usage

Developers typically interact with setuptools via a project configuration file and command-line tooling. Common workflows appear in project repositories hosted on GitHub, GitLab, and Bitbucket and involve commands interoperable with pip (software), virtual environments created by virtualenv, and dependency pinning tools such as pipenv and Poetry (software). Typical user steps include: - Declaring package metadata and install_requires for libraries used by projects like Django and NumPy. - Registering console_scripts entry points to create command-line interfaces for tools such as httpie and gunicorn. - Building distribution artifacts that downstream consumers on PyPI and internal artifact registries like Artifactory can install. setuptools also integrates with continuous delivery pipelines used by organizations like Mozilla, Netflix, and Red Hat to standardize build and deployment.

Packaging and Distribution

setuptools produces source distributions and has historically supported building eggs, while modern workflows emphasize wheel files conforming to PEP 427. Packaging with setuptools often complements tools like wheel (package format), twine (utility), and repository services including PyPI and DevPI. Build back ends invoking setuptools must interoperate with front ends following specifications in PEP 517 and PEP 518, allowing build isolation used by pip (software) when installing from source. Enterprises leverage setuptools-generated artifacts in combination with artifact managers such as Nexus Repository Manager and continuous integration orchestrators like TeamCity for reproducible deployments.

Configuration and Metadata

Projects declare configuration through files and metadata conventions that are parsed by setuptools and allied tools. Metadata fields intersect with standards from PEP 566 and earlier packaging specifications; they include author and maintainer information akin to records used by Apache Software Foundation-hosted projects and license identifiers recognized by Open Source Initiative. Configuration may appear in legacy files referenced by distutils or in modern declarative formats compatible with pyproject.toml as advocated by PEP 518. This enables integration with dependency specification tools used by organizations such as Canonical and Microsoft and supports classifiers aligned with package indexing policies maintained on PyPI.

Integration and Ecosystem

setuptools sits within a broader ecosystem that includes pip (software), virtualenv, wheel (package format), and emerging build tools like flit and Poetry (software). It interoperates with testing frameworks such as pytest and unittest (framework), documentation generators like Sphinx (software), and continuous integration services including Travis CI and CircleCI. Community governance and discussions often occur in venues tied to the Python Software Foundation and repositories on GitHub, where contributors from organizations such as Google, Red Hat, Canonical, and Microsoft participate. As packaging standards evolve via the Python Packaging Authority and PEP process, setuptools continues adapting to proposals that affect build back ends, metadata, and distribution formats.

Category:Python (programming language) libraries