pythonccf 0.1.2

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](#installation)

• [Usage](#usage)

• [Functionality](#functionality)

• [Requirements](#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

• Updates usages of renamed objects in code and docstrings

• Adds docstring templates for functions and methods in reStructured Text format

# Requirements

• python>=3.5