PyPI Toolkit

pypi-toolkit is a command-line tool designed to simplify the process of building, testing, and uploading Python packages to PyPI.

Table of Contents

• Motivation
• Features
• Checklist
  • Current Features
  • Upcoming Features
• Installation
• Usage

Motivation

Publishing Python packages to PyPI can be a repetitive and error-prone process. pypi-toolkit aims to streamline this workflow by providing a single tool that handles building, testing, and uploading your packages, ensuring consistency and reducing the likelihood of mistakes. With pypi-toolkit, it becomes much easier to quickly build, test, and upload your PyPI package.

Features

• Create: Initialize package folder structure.
• Build: Creates source and wheel distributions.
• Test: Runs your test suite using pytest.
• Upload: Uploads your package to PyPI using twine.
• All: Performs build, test, and upload in sequence.

Checklist

Current Features

• Build source and wheel distributions
• Run tests using pytest
• Upload packages to PyPI using twine
• Perform build, test, and upload in sequence
• [+] Template management with cookiecutter

Upcoming Features

• Automated version bumping
• Integration with CI/CD pipelines
• Enhanced logging and error reporting
• Support for additional testing frameworks
• KeyRing management with Twine

Installation

You can install pypi-toolkit using pip:

pip install pypi-toolkit

Usage

After installing pypi-toolkit, you can use the following commands:

• To create your package:

  pypi-toolkit create_package

• To build your package:

  pypi-toolkit build

• To test your package:

  pypi-toolkit test

• To upload your package to PyPI:

  pypi-toolkit upload

• To perform build, test, and upload in sequence:

  pypi-toolkit all