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

.. only:: html

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

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

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

.. _sphx_glr_tutorial_quickstart_installation.py:


.. _installation:

Installation
============================

AgentScope requires Python 3.10 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 -b main https://github.com/agentscope-ai/agentscope
    cd agentscope
    pip install -e .

To ensure AgentScope is installed successfully, check via executing 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

    1.0.0




.. GENERATED FROM PYTHON SOURCE LINES 35-57

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

To satisfy the requirements of different functionalities, AgentScope provides
extra dependencies that can be installed based on your needs.

- full: Including extra dependencies for model APIs and tool functions
- dev: Development dependencies, including testing and documentation tools

For example, when installing the full dependencies, the installation command varies depending on your operating system.

For Windows users:

.. code-block:: bash

      pip install agentscope[full]

For Mac and Linux users:

.. code-block:: bash

      pip install agentscope\[full\]


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

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


.. _sphx_glr_download_tutorial_quickstart_installation.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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