she

shed

`shed` canonicalises Python code. Shed your legacy, stop bikeshedding, and move on. Black++

Showing:

Popularity

Downloads/wk

0

GitHub Stars

84

Maintenance

Last Commit

6d ago

Contributors

3

Package

Dependencies

8

License

AGPL-3.0

Categories

Readme

shed

shed canonicalises Python code. Shed your legacy, stop bikeshedding, and move on. Black++

What does it do?

shed is the maximally opinionated autoformatting tool. It's all about convention over configuration, and designed to be a single opinionated tool that fully canonicalises my code - formatting, imports, updates, and every other fix I can possibly automate.

There are no configuration options at all, but if the defaults aren't for you that's OK - you can still use the underlying tools directly and get most of the same effect... though you'll have to configure them yourself.

shed must either be run in a git repo to auto-detect the files to format, or explicitly passed a list of files to format on the command-line.

Features

shed...

  • Runs autoflake, to remove unused imports and variables
  • Runs pyupgrade, with autodetected minimum version >= py36
  • Runs isort, with autodetected first-party imports and --ca --profile=black args
  • Runs black, with autodetected minimum version >= py36
  • Formats code blocks in docstrings, markdown, and restructured text docs (like blacken-docs).
  • If shed --refactor, also runs pybetter to fix style issues, teyit to update deprecated unittest methods, and com2ann to convert type comments to annotations.

The version detection logic is provided by black, with an extra step to discard versions before Python 3.6.

If you run shed in a Git repository, the name of the root directory is assumed to be a first-party import. src layout packages are also automatically detected, i.e. the foo in any paths like .../src/foo/__init__.py.

Jupyter Notebook support

We recommend using jupytext to save your notebooks in .py or .md files, in which case shed supports them natively. For a quick-and-dirty workflow, you can use nbqa shed notebook.ipynb - nbqa works for any linter or formatter.

Using with pre-commit

If you use pre-commit, you can use it with Shed by adding the following to your .pre-commit-config.yaml:

minimum_pre_commit_version: '2.9.0'
repos:
- repo: https://github.com/Zac-HD/shed
  rev: 0.4.2
  hooks:
    - id: shed
      # args: [--refactor, --py39-plus]
      types_or: [python, markdown, rst]

This is often considerably faster for large projects, because pre-commit can avoid running shed on unchanged files.

See also

shed inherits pyupgrade's careful approach to converting string formatting code. If you want a more aggressive refactoring tool and don't mind checking for breaking changes, check out flynt.

Changelog

Patch notes can be found in CHANGELOG.md.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100