Home

About

SnakeCharm is a plugin for PyCharm / IntelliJ Platform IDEs which adds support for Snakemake workflows language

Installation

See README.md

Setup Snakemake support

To enable all code insight features (e.g. code completion for directory, touch etc methods) please configure Python SDK with installed snakemake package.

Otherwise not all smart code insight features will be enabled and you could see errors like Unresolved reference for all snakemake specific methods.

In PyCharm:

• Open PyCharm | Preferences | Project: <name> | Project Interpreter

  

• Press gear icon and choose 'Add..'

• Select Python Interpreter, e.g. Conda Environment | Existing environment | Interpreter: some conda env with snakemake package installed. Press OK.

  

• Ensure that project interpreter is set. Press OK.

  

• Wait until indexing and updating python library skeletons has finished

  

Example: Snakemake support is configured:

Code completion works for Snakemake specific methods and usages of these methods not highlighted with Unresolved reference error.

Example: Interpreter with snakemake not configured:

In this case not all smart code insight features are enabled and you could see errors like Unresolved reference for all snakemake specific methods.