Should I use Markdown or reStructuredText for my Python project?

This skill provides a strategy for choosing: Markdown is generally better for simplicity and GitHub compatibility, while RST is preferred for projects heavily integrated with Sphinx.

Does this work with the modern pyproject.toml format?

Yes, it provides specific configurations for declaring README files and content types within the [project] table of pyproject.toml.

How do I check if my README will render correctly before uploading?

The skill guides you through using 'twine check' after building your distribution packages to validate markup before publication.

Why does my README look broken on PyPI but fine on GitHub?

PyPI uses a specific renderer that often restricts certain Sphinx extensions or custom HTML tags allowed by GitHub; this skill helps you identify and fix these incompatibilities.

PyPI README Creator

Name: PyPI README Creator
Author: Jamie-BitFlight

byJamie-BitFlight

•

Content Management

Generates professional, PyPI-compliant README files in Markdown or reStructuredText to ensure correct rendering across Python package indexes.

About

The pypi-readme-creator skill helps developers navigate the technical requirements of Python package documentation, ensuring README files render flawlessly on PyPI, GitHub, and GitLab. It provides expert guidance on choosing between Markdown and reStructuredText, configuring pyproject.toml metadata, and troubleshooting common rendering errors with tools like twine check. Whether you are launching a new project or migrating Sphinx documentation, this skill ensures your package's first impression is polished, accessible, and technically accurate.

Key Features

Validation of markup to prevent rendering errors on PyPI
10 GitHub stars
Sphinx documentation integration using sphinx-readme
Metadata configuration for pyproject.toml and setup.py
Platform-specific syntax support for GitHub, GitLab, and BitBucket
Automated PyPI-compliant README generation in Markdown and RST

Use Cases

Converting existing Sphinx documentation into a PyPI-compatible format
Troubleshooting 'invalid markup' errors during the twine check process
Preparing a new Python package for publication on the Python Package Index (PyPI)

About

Key Features

Validation of markup to prevent rendering errors on PyPI
10 GitHub stars
Sphinx documentation integration using sphinx-readme
Metadata configuration for pyproject.toml and setup.py
Platform-specific syntax support for GitHub, GitLab, and BitBucket
Automated PyPI-compliant README generation in Markdown and RST

Use Cases

Converting existing Sphinx documentation into a PyPI-compatible format
Troubleshooting 'invalid markup' errors during the twine check process
Preparing a new Python package for publication on the Python Package Index (PyPI)