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. The JSON schema lists every field it accepts.

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.45.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 links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for brendanator from gravatar.com brendanator Avatar for Hellebore from gravatar.com Hellebore

Credits

Author: Sourcery AI

License

Proprietary

Classifiers

Report project as malware

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

If you're not sure about the file name format, learn more about wheel file names.

sourcery-1.45.0-py2.py3-none-win_amd64.whl (93.1 MB view details)

Uploaded Python 2Python 3Windows x86-64

sourcery-1.45.0-py2.py3-none-manylinux1_x86_64.whl (135.2 MB view details)

Uploaded Python 2Python 3

sourcery-1.45.0-py2.py3-none-macosx_11_0_arm64.whl (95.0 MB view details)

Uploaded Python 2Python 3macOS 11.0+ ARM64

sourcery-1.45.0-py2.py3-none-macosx_10_9_x86_64.whl (109.5 MB view details)

Uploaded Python 2Python 3macOS 10.9+ x86-64

File details

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

File metadata

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

File hashes

Hashes for sourcery-1.45.0-py2.py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 e030f7ec164c02ede73a663c0496fe43c9f78caf909a46af5c8ee0ef5077608a
MD5 ff000cb0a452fc2350e8bf5d15a8d484
BLAKE2b-256 391b9ef093491e87e26cc14f6b2542b10bb09973f2d3ee0f35497226109cd47f

See more details on using hashes here.

Provenance

The following attestation bundles were made for sourcery-1.45.0-py2.py3-none-win_amd64.whl:

Publisher: build_sourcery.yml on sourcery-ai/core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for sourcery-1.45.0-py2.py3-none-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 0a41578306dd21de7a09f3030ec01c93535ca2aa3e4df1f75f9a2e38b514d860
MD5 5133701985795003c9821562e5b1586f
BLAKE2b-256 5d96c50165b9aac8c125f2eca414122d45ea5e45511968886db0660bcb59c0d0

See more details on using hashes here.

Provenance

The following attestation bundles were made for sourcery-1.45.0-py2.py3-none-manylinux1_x86_64.whl:

Publisher: build_sourcery.yml on sourcery-ai/core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sourcery-1.45.0-py2.py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for sourcery-1.45.0-py2.py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 37da7803abb008e7cc7380fcedf3447ec661c246a05719ee1a6ca463564616f0
MD5 5616c86a84a3685054dba6990c211d0a
BLAKE2b-256 887d56d4aa1ac17b473a19cda504d245059427026ef6536c6e9f38784250010d

See more details on using hashes here.

Provenance

The following attestation bundles were made for sourcery-1.45.0-py2.py3-none-macosx_11_0_arm64.whl:

Publisher: build_sourcery.yml on sourcery-ai/core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sourcery-1.45.0-py2.py3-none-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for sourcery-1.45.0-py2.py3-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 2795291e30f49d51553d0bba09421b634a367a49e9bb057ec014737a5e53c5a5
MD5 919f17531fc63c92d1cdd85e25fc2eb9
BLAKE2b-256 dea9910c00e60827ad27bd8199cbd8a5caac8599878fc25dfbc82d50096c3e4b

See more details on using hashes here.

Provenance

The following attestation bundles were made for sourcery-1.45.0-py2.py3-none-macosx_10_9_x86_64.whl:

Publisher: build_sourcery.yml on sourcery-ai/core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.45.0 This release

4 files

1.44.0

4 files

1.43.0

4 files

1.41.1

1 file

1.40.0

3 files

1.39.0

3 files

1.38.0

3 files

1.37.0

3 files

1.36.0

3 files

1.35.0

3 files

1.34.0

3 files

1.33.0

3 files

1.32.0

3 files

1.31.0

3 files

1.30.0

3 files

1.29.0

3 files

1.28.0

3 files

1.27.0

3 files

1.26.0

3 files

1.25.0

3 files

1.24.0

3 files

1.0.0

3 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page