This plugin provides the features of PythonTA in your PyCharm editor!
If you are working on the development of this plugin:
- Clone this repository
- Then, run
pre-commit installto install the pre-commit hooks (this will automatically check and format your code every time you commit)
During development, you can test the plugin in a sandbox IDE to see how users might interact with the plugin in a realistic environment.
To launch the sandbox, run the Run Plugin gradle task. This will launch a sandbox IDE with the plugin already installed.
While the plugin is still in development, currently, it can scan a single python file and display the result of the scan to users. Here is a quick demo of how to use the plugin.
Before performing any scans, the plugin needs to know the location of the PyTA executable (python_ta.exe) in your environment. The plugin
first tries to detect this automatically. But, if it is unable to detect python_ta.exe file on its own, it can be provided
manually through File > Settings > Tools > PythonTA Plugin Configuration.
Once the path for the PyTA executable has been configured, a PyTA scan on a python file can be performed. The action to perform
the scan is available at three locations. The action in all of these locations is only available for python files (those with a .py extension)
- Editor Pop-Up Menu: This menu can be opened by right-clicking on the text editor
- Project View Pop-Up Menu: This menu can be opened by right-clicking on a python file in the Project View
- Code Menu: This menu is present in the topmost toolbar. Note that in the image below, the action is only visible because the file selected (
sample.py) is a python file.
A scan can be performed by clicking on Scan File with PythonTA in any of these menus.
Once a scan has been performed, the results of the scan can be viewed in the PythonTA Tool Window, present at the bottom
of the IDE. 
Plugin based on the IntelliJ Platform Plugin Template.