Skip to main content

Magically refactor Python

Project description

Sourcery Logo

Sourcery Command Line Interface

Installation and usage

Installation

Sourcery command line interface can be installed by running:

pip install sourcery

Login

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

Usage

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

sourcery review example_file.py

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

sourcery review --fix {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 -

Options:
  --diff TEXT               Run only on changed code with diff command (e.g.
                            "git diff")
  --enable TEXT             Only run the specified rule or tag. This option
                            can be used multiple times.
  --disable TEXT            Skip the specified rule or tag. This option can
                            be used multiple times.
  --check                   Return exit code 1 if unsolved issues found.
  --fix                     Automatically fix issues where possible.
  --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.
  --summary / --no-summary  Flag to determine whether to print a summary of
                            the review. Default: true.
  -h, --help                Show this message and exit.

Configuration

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:

repos:
  - repo: https://github.com/sourcery-ai/sourcery
    rev: v1.37.0
    hooks:
      - 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 --fix option:

args: [--diff=git diff HEAD, --fix]

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
# 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-1.37.0-py2.py3-none-win_amd64.whl (95.6 MB view details)

Uploaded Python 2Python 3Windows x86-64

sourcery-1.37.0-py2.py3-none-manylinux1_x86_64.whl (118.1 MB view details)

Uploaded Python 2Python 3

sourcery-1.37.0-py2.py3-none-macosx_10_9_universal2.whl (96.4 MB view details)

Uploaded Python 2Python 3macOS 10.9+ universal2 (ARM64, x86-64)

File details

Details for the file sourcery-1.37.0-py2.py3-none-win_amd64.whl.

File metadata

  • Download URL: sourcery-1.37.0-py2.py3-none-win_amd64.whl
  • Upload date:
  • Size: 95.6 MB
  • Tags: Python 2, Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for sourcery-1.37.0-py2.py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 0a74d7a38e194d6c0fb0cda497089b876d436218eea4e41037ecc4de4677ad2c
MD5 0ceb037de9ad846f22bb757f4d35451f
BLAKE2b-256 43fe742f8162c5becab4adbb72f1d732bec77d13da90a8eb4950d21f34ca38a5

See more details on using hashes here.

File details

Details for the file sourcery-1.37.0-py2.py3-none-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for sourcery-1.37.0-py2.py3-none-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 b674457203201c6716b5318f15964f904f482837ef7a32e6bef0f68b03db6cb6
MD5 7f0cc5553a94848ab922179326e44f74
BLAKE2b-256 e0d1a2c83fd38312355f1b97a1cf6e03dc4deb02ac5194680d34056b3e4cd5fb

See more details on using hashes here.

File details

Details for the file sourcery-1.37.0-py2.py3-none-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for sourcery-1.37.0-py2.py3-none-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 e9d6cb885524bb417e522155e8fea75e947a75ecd29edae2549c937c568880fd
MD5 1a3e0e65ddd4f7d5490194c02c9f93e2
BLAKE2b-256 f6664c66a36402ab97d81b518ae5eef68c49a9ec2bf49bd362723e07099c19e3

See more details on using hashes here.

Supported by

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