Skip to content

cherenkov-plenoscope/black_pack

Repository files navigation

black-pack

TestStatus PyPiStatus BlackStyle BlackPackStyle MITLicenseBadge

BlackPackLogo

BlackPackStyle

Linting and structural checking for python-packages. Black-pack helps you to organize your python-package. Black-pack is very basic and not meant to support custom structures. Black-pack only checks if a python-package has a specific structure which the author thinks is 'reasonable practice' and which is now backed into black-pack. Black-pack is meant to help you keep your various python-packages in 'reasonable' shape with ease. The name 'black-pack' is becasue black-pack adopts parts of the mindset found in 'black'.

Install

pip install black_pack

Usage on command-line

Check

black-pack check /path/to/my/python-package

Black-pack will print a list of errors to stdout when your package differs from black-pack's backed in expectations.

Init

black-pack init /path/to/my/new/python-package

Will write an entire skeleton for your python-package (All directories and files). You can pass optional arguments to e.g. specify the package's name.

Write

black-pack write /path/to/my/python-package .gitignore

Writes a single specific file, e.g. the .gitignore.