pythonccf 0.2.0

A simple tool for renaming and documenting Python code according to PEP

pythonccf

A simple tool for renaming and documenting Python code according to PEP

Table of contents

• Installation
• Usage
• Functionality
• Requirements

Installation

pip install pythonccf

Usage

pythonccf [args]
  
Arguments:  
  -h, --help            Show help message and exit  
  -p P                  Path to project to format .py files in  
  -d D                  Directory to format .py files in  
  -f F                  .py file(s) to format  
  -v, --verify          Verify object names and documentation  
  -o, --output          Output fixed files  
  --output-prefix       Output path prefix

Usage example

pythonccf -f examples/test*.py -o --output-prefix output

Functionality

• Verifies and converts class names to CamelCase
• Verifies and converts function and variable names to snake_case
• Verifies and converts file and directory names in project to snake_case
• Updates usages of renamed objects in code and docstrings
• Adds docstring templates for functions, methods and classes in reStructured Text format
• Adds skipped arguments to docstrings

Requirements

• python>=3.5