Skip to main content

`shed` canonicalises Python code.

Project description

shed

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

What does it do?

shed is basically black plus autoflake plus isort plus pyupgrade plus some custom fixers.

shed is all about convention over configuration. It's 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.

Only works in git repos, because version control is great and so is git ls-files, or in single-file mode.

Features

shed...

  1. Runs autoflake, to remove unused imports and variables, and expand star-imports
  2. Runs isort (configuration support waiting on 5.0), with autodetected first-party imports
  3. Runs pyupgrade, with autodetected minimum version >= py36
  4. Runs black, with autodetected minimum version >= py36
  5. (WIP) Runs some custom fixers based on flake8-bugbear
  6. Iterates those steps until the source code stops changing.

Changelog

0.0.2 - 2020-03-08

  • usable CLI
  • better isort autoconfig

0.0.1 - 2020-02-15

  • project kickoff

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shed-0.0.1.tar.gz (3.9 kB view hashes)

Uploaded Source

Built Distribution

shed-0.0.1-py3-none-any.whl (16.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page