Skip to content

likianta/lkfmt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Likianta Flavored Formatter

lkfmt (Likianta flavored formatter) is an integration of black + isort + autoflake with pre-defined settings to reformat my Python script code.

Features

  • black + isort + autoflake integration
  • out-of-box settings
  • one command to drive
  • additional format styles by lk-flavor (work in progress)
    • keep indents on empty lines
    • ensure newline at end of file
    • merge one-line if/for statements
    • align : in dict key-value pairs
    • align = in multi-line assignments
    • tweak black styles to balance the visual weight
    • use # nofmt to skip formatting (like # noqa)

Installation

pip install lkfmt (not yet published)

pip install git+https://github.com/likianta/lkfmt.git

Usage

use in command line:

# after installation, there's an executable named `lkfmt`.

# get help
lkfmt -h

# format files in current dir
lkfmt .
# it can also be shorthand as `lkfmt` (no argument)

# format files in current dir and subdirs recursively
lkfmt -r .

# format one file
lkfmt $file

# show difference (but not inplace file)
python -m lkfmt show-diff $file

Screenshots

About

All-in-one Python code formattor which is tailored of "black + isort + autoflake" for myself taste.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages