PyCharm

To enable hot-deployment from PyCharm and related IDEs, ensure you have first followed the configuration instructions in IDE integration overview.

Supported products

  • PyCharm and Professional
  • IntelliJ Community and Ultimate with the Python plugin
  • Minimal IDE version is 2016.3+

Configuration

As the Zato IDE hot-deployment plugin is published in the JetBrains Plugin Repository, installation on PyCharm is achieved directly from within the application.

  1. Visit Preferences -> Plugins, then click Browse repositories:

    ../../_images/pycharm_plugins.jpg
  2. Search for Zato, then click the Install button:

    ../../_images/pycharm_plugins_zato.jpg
  3. Once installation completes, visit Preferences -> Languages & Frameworks -> Zato to populate connection information for your development cluster:

    ../../_images/pycharm_settings.jpg

Automatic deployment

Automatic deployment is triggered on every file save if a Python file contains a special deployment marker within its first 100 lines of source code:

# zato: ide-deploy=True

For instance:

# zato: ide-deploy=True

from zato.server.service import Service

class MyService(Service):
    def handle(self):
        pass
../../_images/pycharm_ide_deploy_true1.jpg

Manual deployment

With a Zato service open in an editor window, visit Tools -> Upload to default Zato server to trigger upload manually:

../../_images/pycharm_deploy_menu.jpg

Success

Success is indicated in the status bar at the bottom of the window:

../../_images/pycharm_hot_deployed.jpg