mocha: show actual file in Diff dialog (WEB-15907)
[idea/community.git] / python / README.md
1 # PyCharm Community Edition
2
3 The "python" directory in the source repository contains the source code of PyCharm Community Edition and the Python plugin for
4 IntelliJ IDEA Community Edition.
5
6 ## Skeletons
7
8 In order to successfully run the full test suite for PyCharm Community Edition and to build a fully working distribution, you need to
9 check out the library skeletons, which are stored in a separate Git repository. To do this, you need to change to the 'helpers'
10 directory and run the following command:
11
12     git clone https://github.com/JetBrains/python-skeletons.git
13
14 ## Building and Running
15
16 The code is part of the main IntelliJ IDEA Community Edition project and is compiled together with the rest of the codebase.
17 To run PyCharm Community Edition, please use the provided run configuration "PyCharm Community Edition". To run IntelliJ IDEA with
18 the Python plugin, please use the "IDEA with Python plugin" run configuration.
19
20 To run the test suite, use the built-in JUnit test runner and run all tests in the "python-community-tests" module.
21
22 ## Building from the Command Line
23
24 To build the distribution archive of PyCharm Community Edition, execute build.xml Ant build script in this directory. The results of the
25 build execution can be found at out/artifacts.
26
27 ## Building the Python Plugin
28
29 To build the Python plugin for IntelliJ IDEA Community Edition:
30
31  * Download the .tar.gz distribution of the most recent EAP or release build of IntelliJ IDEA Community Edition;
32  * Run the following command:
33
34    ant -Didea.path=<download path> -Didea.build.number=<build number of the build you're using> plugin
35
36 The .zip file of the built plugin will be placed at distCE/python-community-<branch number>.SNAPSHOT.zip