hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 10:17:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

pycharm.md: Gradle 1.x/2.x

Browse Source
This commit is contained in:
Yann Cébron 2024-07-29 16:57:12 +02:00
parent e4fe426be6
commit d9692fbb1f
1 changed files with 39 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
topics/products/pycharm/pycharm.md
View File

@ -13,7 +13,39 @@ Plugin projects for PyCharm can be developed using IntelliJ IDEA with the [](too
<include from="snippets.md" element-id="jetbrainsProductOpenSourceLicense"/>
## Configuring Plugin Projects Targeting PyCharm
## WebStorm Plugin Setup
### Gradle Build Script
<tabs>
<tab title="IntelliJ Platform Gradle Plugin (2.x)">
Define a dependency using [`pycharmCommunity()` or `pycharmProfessional()`](tools_intellij_platform_gradle_plugin_dependencies_extension.md), see _Versions_ link on top of this page for all available versions.
See [](tools_intellij_platform_gradle_plugin.md#dependenciesLocalPlatform) for using a local installation.
A dependency on the matching bundled `PythonCore`/`Pythonid` plugin (see [](#python-plugins) below) must be added using the [`bundledPlugin()`](tools_intellij_platform_gradle_plugin_dependencies_extension.md#plugins) helper.
Minimum <path>build.gradle.kts</path> setup:
```kotlin
repositories {
mavenCentral()
intellijPlatform {
defaultRepositories()
}
}
dependencies {
intellijPlatform {
pycharmCommunity("<versionNumber>")
bundledPlugin("PythonCore")
}
}
```
</tab>
<tab title="Gradle IntelliJ Plugin (1.x)">
The configuration of PyCharm plugin projects follows the methods described in [Configuring Plugin Projects using a Product-Specific Attribute](dev_alternate_products.md#configuring-plugin-projects-using-a-product-specific-attribute), and [Configuring the plugin.xml File](dev_alternate_products.md#configuring-pluginxml).
The table below summarizes the [](tools_gradle_intellij_plugin.md) attributes to set in the Gradle build script.
@ -27,6 +59,11 @@ Click on an entry in the table's *Attribute* column to go to the documentation a
| [`intellij.downloadSources`](tools_gradle_intellij_plugin.md#intellij-extension-downloadsources) | `false` is required because no public source code is available. |
| [`runIde.ideDir`](tools_gradle_intellij_plugin.md#tasks-runide-idedir) | Not needed; the Development Instance will automatically match `intellij.type`. |
</tab>
</tabs>
### plugin.xml
The dependency on the PyCharm APIs must be declared in the <path>[plugin.xml](plugin_configuration_file.md)</path> file.
As described in [Configuring the plugin.xml File](dev_alternate_products.md#configuring-pluginxml), the [`<depends>`](plugin_configuration_file.md#idea-plugin__depends) tag must declare `com.intellij.modules.python`.
@ -38,6 +75,7 @@ As described in [Configuring the plugin.xml File](dev_alternate_products.md#conf
| [Python](https://plugins.jetbrains.com/plugin/631-python) | `Pythonid` | PyCharm Professional Edition (`PY`) |
#### Python Plugins 2024.2
{id="python242"}
<primary-label ref="2024.2"/>