Skip to main content

Magically refactor Python

Project description

Sourcery Logo

Sourcery Command Line Interface

Installation and usage


Sourcery command line interface can be installed by running:

pip install sourcery-cli


Once installed you need to log in with:

sourcery login

which will open up a browser tab and ask for confirmation. This is only needed once per computer.

You can also log in via providing your token:

sourcery login --token YOUR_TOKEN


To review a file or a directory (recursively) with Sourcery, use the sourcery review command:

sourcery review

To apply the changes suggested by Sourcery, use the --in-place option:

sourcery review --in-place {file_or_directory}

Command Line Options

Sourcery provides a few options for running. You can list them by running sourcery review --help

sourcery review --help

Usage: sourcery review [OPTIONS] [SRC]...

  Review SRC files/directories. Reads from stdin when SRC is -

  -c, --code TEXT     Refactor the code passed in as a string.
  --diff TEXT         Run only on changed code with diff command (e.g. "git diff")
  --enable TEXT       Only run the specified rule/tag. This option can be used
                      multiple times.
  --disable TEXT      Do not run the specified rule/tag. This option can be used
                      multiple times.
  --check             Return exit code 1 if unsolved issues found.
  --in-place          Make changes to files in place
  --config FILE       Location of the Sourcery YAML config file. Can be a file or URL.
  --csv               Output in CSV format
  --verbose           Verbose output with explanation and code snippets.
  -h, --help          Show this message and exit.


Sourcery reads configuration settings from .sourcery.yaml in the project directory. Full details are described here.

Pre-commit Hook

Sourcery works great with pre-commit. Once you have it installed, add this to the .pre-commit-config.yaml in your repository:

  - repo:
    rev: v1.0.1
      - id: sourcery
        # The best way to use Sourcery in a pre-commit hook:
        # * review only changed lines:
        # * omit the summary
        args: [--diff=git diff HEAD, --no-summary]

To review all changes compared to the main branch:

args: [--diff=git diff main]

If you want Sourcery to automatically apply the suggested changes,add the --in-place option:

args: [--diff=git diff HEAD, --in-place]

If Sourcery is the first pre-commit hook that you've added to your project, you'll also need to run pre-commit install.

Continuous Integration

For the majority of projects, the best usage of Sourcery in the CI is to review only the code of the current PR.

You can use the script below to detect Sourcery violations that are present in the current code but not in the main branch:

pip install sourcery-cli
# Store your Sourcery token as a secret in your CI environment.
sourcery login --token $SOURCERY_TOKEN
sourcery review --diff "git diff main" .

Instead of main, you can pick another branch as well. For example, in GitHub Actions you can use --diff="git diff ${{ github.event.pull_request.base.sha }}"

Project details

Download files

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

Source Distributions

No source distribution files available for this release. See tutorial on generating distribution archives.

Built Distributions

sourcery_cli-1.0.1-py2.py3-none-win_amd64.whl (62.2 MB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page