DC006: ReadmeStructure
Overview
| Property | Value |
|---|---|
| ID | DC006 |
| Name | ReadmeStructure |
| Group | documentation |
| Severity | WARNING |
Description
Checks that the README file contains essential sections including installation and usage instructions.
A well-structured README helps users quickly understand how to install and use your package.
What it checks
The check looks for these essential sections in your README:
- Installation - How to install the package
- Usage - Basic usage examples or quick start guide
It searches for common section headings like:
- “Installation”, “Install”, “Getting Started”, “Setup”
- “Usage”, “Quick Start”, “Example”, “Examples”, “How to Use”
Why it matters
- User Experience - Users can quickly get started with your package
- Adoption - Clear instructions increase package adoption
- Support Reduction - Fewer “how do I install this?” issues
- pyOpenSci - Required for pyOpenSci review
- Best Practices - Follows Python packaging conventions
How to fix
Add installation and usage sections to your README:
# My Package
A brief description of what your package does.
## Installation
Install from PyPI:
```bash
pip install my-packageOr with uv:
uv add my-packageDevelopment installation
git clone https://github.com/username/my-package
cd my-package
pip install -e ".[dev]"Usage
Basic example
from my_package import MyClass
# Create an instance
obj = MyClass()
# Perform an action
result = obj.do_something()
print(result)Advanced usage
# More complex examples...Documentation
Full documentation is available at docs.example.com.
## Configuration
### Skip this check
```toml
[tool.pycmdcheck]
skip = ["DC006"]CLI
pycmdcheck --skip DC006