.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "build_tutorial/quickstart.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

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

        :ref:`Go to the end <sphx_glr_download_build_tutorial_quickstart.py>`
        to download the full example code.

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

.. _sphx_glr_build_tutorial_quickstart.py:


.. _quickstart:

Quick Start
============================

AgentScope requires Python 3.9 or higher. You can install from source or pypi.

From PyPI
----------------
.. code-block:: bash

    pip install agentscope

From Source
----------------
To install AgentScope from source, you need to clone the repository from
GitHub and install by the following commands

.. code-block:: bash

    git clone https://github.com/modelscope/agentscope
    cd agentscope
    pip install -e .

To ensure AgentScope is installed normally. You can execute the following code:

.. GENERATED FROM PYTHON SOURCE LINES 29-34

.. code-block:: Python


    import agentscope

    print(agentscope.__version__)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    0.1.6




.. GENERATED FROM PYTHON SOURCE LINES 35-68

Extra Dependencies
----------------------------

AgentScope provides extra dependencies for different demands. You can
install them according to your demands.

- ollama: Ollama API
- litellm: Litellm API
- zhipuai: Zhipuai API
- gemini: Gemini API
- anthropic: Anthropic API
- service: The dependencies for different tool functions
- distribute: The dependencies for distribution mode
- full: All the dependencies

Taking distribution mode as an example, the installation command differs
according to your operation OS.

For Windows users:

.. code-block:: bash

      pip install agentscope[gemini]
      # or
      pip install agentscope[ollama,distribute]

For Mac and Linux users:

.. code-block:: bash

      pip install agentscope\[gemini\]
      # or
      pip install agentscope\[ollama,distribute\]


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 3.663 seconds)


.. _sphx_glr_download_build_tutorial_quickstart.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_