Troubleshooting¶

What is the Sourcery Log?¶

The sourcery.log file collects information useful for debugging potential issues you may run into while using Sourcery. Occasionally we may ask you to send us your log file to help us diagnose a problem.

Depending on your operating system you can find sourcery.log at:

Operating System	Path
Linux	`~/.local/share/sourcery/sourcery.log`
Mac	`~/Library/Application Support/sourcery/sourcery.log`
Windows	`%LOCALAPPDATA%\sourcery\sourcery.log`

How do I connect to Sourcery behind firewall/corporate proxy?¶

Follow the steps to configure Sourcery to use a proxy.

Sourcery not Working on Non-Actively Supported Linux distros¶

One of the possible causes for Sourcery not to function properly when run on Linux distros that are not actively supported is an incompatible version of the libxcrypt library.

JetBrains users suffering from this have reported getting the following error message:

java.util.concurrent.ExecutionException: org.eclipse.lsp4j.jsonrpc.JsonRpcException: java.io.IOException: Stream closed

As discussed in a GitHub issue, this may be solved by installing libxcrypt-compat:

pacman -S libxcrypt-compat

Sourcery not Working on Apple M1¶

Sourcery does not currently ship M1-native binaries, and this may cause it to fail to execute on Apple M1-based devices if Rosetta is not installed.

JetBrains users affected by this problem may get the following error message:

Support/JetBrains/PyCharm2021.3/plugins/sourcery/sourcery_binaries/install/mac"): error=86, Bad CPU type in executable Please retry using the refresh button.

To be able to use Sourcery on such devices, you need to install Rosetta:

/usr/sbin/softwareupdate --install-rosetta --agree-to-license

What do I do if I see the `Project disabled for account` screen?¶

Open Source Accounts¶

Sourcery is free to use for open source projects, and otherwise requires a paid account. To determine whether a project is open source we look at the linked url in the version control system being used, and check that this url is publicly accessible from our server.

Logged in with the wrong account¶

We accept multiple forms of authentication when logging in - GitHub, Google and email/password. If you have signed up for a Pro or Team account and you are seeing this message it's possible that you have logged in via a different method and created an extra Sourcery account.

To address this you can try logging in again, making sure to use the account credentials for your paid account. If this still doesn't work you can use the user token from the dashboard in our website to log in.

In VS Code navigate to Settings and search for sourcery, then enter the token into the Sourcery: token field.
In PyCharm navigate to Settings > Tools > Sourcery and enter your token.

Proxy Issues¶

If we have failed to authenticate your account this could be due to proxy settings if you are behind a firewall. To address this configure Sourcery to use a proxy.

Contact Us¶

If you still think you are being shown this screen in error then please contact us at support@sourcery.ai, letting us know the problem and attaching your latest Sourcery log file.