.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples\gallery_examples\02-importing\import_project_zip_file.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_gallery_examples_02-importing_import_project_zip_file.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_gallery_examples_02-importing_import_project_zip_file.py:


.. _ref_sherlock_project_import:

=================================
Sherlock Project Import with gRPC
=================================

This example demonstrates how to launch the Sherlock gRPC service, import a
project archive, and handle common exceptions during the import process.

Description
===========

Sherlock's gRPC API enables automation of various workflows, including project
management.
This script demonstrates how to:
- Connect to the Sherlock service.
- Import a sample project archive.
- Handle import errors gracefully.

.. GENERATED FROM PYTHON SOURCE LINES 44-53

.. code-block:: Python



    import os

    from examples.examples_globals import get_sherlock_tutorial_path

    from ansys.sherlock.core import launcher
    from ansys.sherlock.core.errors import SherlockImportProjectZipArchiveError


.. GENERATED FROM PYTHON SOURCE LINES 55-58

Connect to Sherlock
===================
Connect to the Sherlock service and ensure proper initialization.

.. GENERATED FROM PYTHON SOURCE LINES 58-61

.. code-block:: Python


    sherlock = launcher.connect(port=9092, timeout=10)


.. GENERATED FROM PYTHON SOURCE LINES 62-65

Delete Project
==============
Delete the project if it already exists.

.. GENERATED FROM PYTHON SOURCE LINES 65-72

.. code-block:: Python


    try:
        sherlock.project.delete_project("Test")
        print("Project deleted successfully.")
    except Exception:
        pass


.. GENERATED FROM PYTHON SOURCE LINES 73-76

Import Sherlock Project
=======================
Import the tutorial project zip archive from the Sherlock tutorial directory.

.. GENERATED FROM PYTHON SOURCE LINES 76-86

.. code-block:: Python


    try:
        sherlock.project.import_project_zip_archive(
            project="Test",
            category="Demos",
            archive_file=os.path.join(get_sherlock_tutorial_path(), "Auto Relay Project.zip"),
        )
        print("Tutorial project imported successfully.")
    except SherlockImportProjectZipArchiveError as e:
        print(f"Error importing project: {e}")


.. _sphx_glr_download_examples_gallery_examples_02-importing_import_project_zip_file.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: import_project_zip_file.ipynb <import_project_zip_file.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: import_project_zip_file.py <import_project_zip_file.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: import_project_zip_file.zip <import_project_zip_file.zip>`