python-packaging

athola 的头像作者 athola

创建具有适当结构和可发布性的Python包。触发器:Python打包、pyproject.toml、uv、pip、PyPI、分发、CLI工具、入口点、包结构、发布。用途:创建Python包、配置pyproject.toml、设置入口点、发布到PyPI、包的CI/CD。不要在测试包时使用 - 请改用python-testing。不要在优化包性能时使用 - 请使用python-performance。咨询此技能以获取Python包创建和分发信息。

📖 中文导读:创建具有适当结构和可发布性的Python包。触发器:Python打包、pyproject.toml、uv、pip、PyPI、分发、CLI工具、入口点、包结构、发布。用途:创建Python包、配置pyproject.toml、设置入口点、发布到PyPI、包的CI/CD。不要在测试包时使用 - 请改用python-testing。不要在优化包性能时使用 - 请使用python-performance。咨询此技能以获取Python包创建和分发信息。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: python-packaging description: |

Triggers: pyproject.toml, pypi, packaging, distribution, python Create distributable Python packages with proper structure and publishing.

Triggers: Python packaging, pyproject.toml, uv, pip, PyPI, distribution, CLI tools, entry points, package structure, publishing

Use when: creating Python packages, configuring pyproject.toml, setting up entry points, publishing to PyPI, CI/CD for packages

DO NOT use when: testing packages - use python-testing instead. DO NOT use when: optimizing package performance - use python-performance.

Consult this skill for Python package creation and distribution. category: packaging tags: [python, packaging, pyproject.toml, uv, pip, pypi, distribution] tools: [package-analyzer, build-runner] usage_patterns: - package-creation - pypi-publishing - cli-tool-development - library-distribution complexity: beginner estimated_tokens: 200 progressive_loading: true modules: - uv-workflow.md - pyproject-patterns.md - entry-points.md - ci-cd-integration.md

Table of Contents

Python Packaging

Modern Python packaging with pyproject.toml, uv, and best practices for distribution.

Quick Start

# Create new project with uv
uv init my-package
cd my-package

# Add dependencies
uv add requests click

# Build package
uv build

# Publish to PyPI
uv publish

Verification: Run the command with --help flag to verify availability.

When to Use

  • Creating distributable Python libraries
  • Building CLI tools
  • Publishing to PyPI
  • Setting up development environments
  • Managing project dependencies

Core Decisions

1. Layout Choice

# Source layout (recommended)
src/my_package/
    __init__.py
    module.py

# Flat layout (simple)
my_package/
    __init__.py
    module.py

Verification: Run the command with --help flag to verify availability.

Source layout benefits:

  • Clear separation of source and tests
  • Prevents accidental imports of uninstalled code
  • Better for packages with complex structure

2. Project Structure

Minimal Project:

**Verification:** Run `pytest -v` to verify tests pass.
my-project/
├── pyproject.toml
├── README.md
├── src/
│   └── my_package/
│       └── __init__.py
└── tests/
    └── test_init.py

Verification: Run pytest -v to verify tests pass.

Complete Project:

**Verification:** Run the command with `--help` flag to verify availability.
my-project/
├── pyproject.toml
├── README.md
├── LICENSE
├── .gitignore
├── src/
│   └── my_package/
│       ├── __init__.py
│       ├── cli.py
│       ├── core.py
│       └── utils.py
├── tests/
│   ├── conftest.py
│   └── test_core.py
└── docs/
    └── index.md

Verification: Run pytest -v to verify tests pass.

Detailed Topics

See modules for detailed information:

Best Practices

  1. Use source layout for anything beyond simple packages
  2. Pin direct dependencies with minimum versions
  3. Use optional dependency groups for dev/docs/test
  4. Include py.typed for type hint support
  5. Add detailed README with usage examples
  6. Use semantic versioning (MAJOR.MINOR.PATCH)
  7. Test on multiple Python versions before publishing

Exit Criteria

  • Modern pyproject.toml configuration
  • Clear dependency specification
  • Proper version management
  • Tests included and passing
  • Build process reproducible
  • Publishing pipeline automated