Does this skill support GitHub Flavored Markdown (GFM)?

Yes, it provides specific guidance for GFM and standard CommonMark to ensure your README renders perfectly on both GitHub and PyPI.

Does it handle pyproject.toml configuration?

Absolutely. It provides exact TOML snippets for the project metadata and URL sections to ensure PyPI correctly displays your project details and documentation links.

Can it help me convert Sphinx documentation for PyPI?

Yes, it includes specialized instructions for using 'sphinx-readme' to generate PyPI-compatible RST files from your existing Sphinx source files.

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

The skill guides you through a validation workflow using 'uv build' and 'twine check' to identify syntax errors and rendering issues locally before you upload to PyPI.

PyPI README Creator

Name: PyPI README Creator
Author: Jamie-BitFlight

byJamie-BitFlight

•

학습 및 문서화

Generates professional, PyPI-compliant README files in Markdown or reStructuredText with integrated validation for Python package publication.

The PyPI README Creator skill streamlines the documentation process for Python developers by providing domain-specific guidance on creating, formatting, and validating README files. It helps users navigate the technical nuances between Markdown and reStructuredText, ensures compatibility across GitHub and PyPI, and automates the configuration of pyproject.toml metadata. By integrating best practices from documentation experts and providing a clear validation workflow using tools like twine, this skill prevents common rendering errors and ensures your project's first impression is polished and professional.

주요 기능

01Supports both Markdown (GFM) and reStructuredText (RST) formats

02Comprehensive templates for installation, quick start, and usage sections

03Pre-publication validation workflow using twine check

0410 GitHub stars

05Automated pyproject.toml metadata and README field configuration

06Sphinx documentation integration via sphinx-readme

사용 사례

01Preparing a new Python package for its initial release on PyPI

02Troubleshooting and fixing 'invalid markup' errors during the package upload process

03Converting complex Sphinx documentation into a PyPI-friendly README.rst

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jamie-bitflight/claude_skills pypi-readme-creator

For use in Claude.ai and ChatGPT

Download Skill