Installing Dependencies
=======================

Install Dependencies in Repositories
-------------------------------------

Install dependencies in any cloned repository using ``uv pip install``:

.. code-block:: bash

   # Install a repository in editable mode
   dbx install mongo-python-driver

   # Install with extras
   dbx install mongo-python-driver -e test

   # Install with multiple extras
   dbx install mongo-python-driver -e test -e aws

   # Install with dependency groups
   dbx install mongo-python-driver --dependency-groups dev,test

   # Combine extras and dependency groups
   dbx install mongo-python-driver -e test -e aws --dependency-groups dev

   # Use -g to specify which group (when repo exists in multiple groups)
   dbx install mongo-python-driver -g pymongo

   # Short forms
   dbx install mongo-python-driver -e test  # install with test extras
   dbx install mongo-python-driver -e test --dependency-groups dev  # install with test extras and dev dependency group

The ``install`` command will:

1. Find the repository by name across all cloned groups
2. Run ``uv pip install -e .`` (or with extras if specified)
3. Optionally install dependency groups with ``--dependency-groups`` flag
4. Display installation results

Example Output
--------------

.. code-block:: bash

   $ dbx install mongo-python-driver -e test
   Installing dependencies in ~/Developer/mongodb/pymongo/mongo-python-driver...

   ✅ Package installed successfully

   $ dbx install mongo-python-driver -e test -e aws --dependency-groups dev
   Installing dependencies in ~/Developer/mongodb/pymongo/mongo-python-driver...

   ✅ Package installed successfully

   Installing dependency groups: dev...

   ✅ Dependency group 'dev' installed successfully

Support for Installing Sub-directories
---------------------------------------

``dbx`` supports installing from repositories with multiple packages in sub-directories. For example, ``langchain-mongodb`` is a repository containing three packages:

- ``libs/langchain-mongodb/``
- ``libs/langgraph-checkpoint-mongodb/``
- ``libs/langgraph-store-mongodb/``

When you install a repository with sub-directories, ``dbx`` automatically detects the ``install_dirs`` configuration and installs each package separately:

.. code-block:: bash

   $ dbx install langchain-mongodb

   Multiple packages detected: installing 3 packages...

     → Installing from libs/langchain-mongodb/...
     ✅ libs/langchain-mongodb/ installed successfully

     → Installing from libs/langgraph-checkpoint-mongodb/...
     ✅ libs/langgraph-checkpoint-mongodb/ installed successfully

     → Installing from libs/langgraph-store-mongodb/...
     ✅ libs/langgraph-store-mongodb/ installed successfully

   ✅ All packages in langchain-mongodb installed successfully!

You can also install repositories with sub-directories using extras and dependency groups:

.. code-block:: bash

   # Install all packages with dev dependencies
   dbx install langchain-mongodb --dependency-groups dev

   # Install all packages with extras
   dbx install langchain-mongodb -e test

Configuring Sub-directory Installation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Repositories with multiple packages are configured in ``config.toml`` using the ``install_dirs`` setting:

.. code-block:: toml

   [repo.groups.langchain]
   repos = [
       "git@github.com:langchain-ai/langchain-mongodb.git",
   ]

   # Sub-directory configuration: specify install directories for repos with multiple packages
   [repo.groups.langchain.install_dirs]
   langchain-mongodb = [
       "libs/langchain-mongodb/",
       "libs/langgraph-checkpoint-mongodb/",
       "libs/langgraph-store-mongodb/",
   ]

Each directory in ``install_dirs`` must contain a ``pyproject.toml`` or ``setup.py`` file.

Showing Available Options
-------------------------

Before installing, you can see what extras and dependency groups are available for a repository:

.. code-block:: bash

   # Show available options for a regular repository
   $ dbx install mongo-python-driver --show-options

   📦 mongo-python-driver

     Extras: aws, encryption, test
     Dependency groups: dev, docs

   # Show available options for a repository with multiple packages
   $ dbx install langchain-mongodb --show-options

   📦 langchain-mongodb (repository with 3 packages)

     Package: libs/langchain-mongodb/
       Extras: test
       Dependency groups: dev

     Package: libs/langgraph-checkpoint-mongodb/
       Extras: test, docs
       Dependency groups: (none)

     Package: libs/langgraph-store-mongodb/
       Extras: (none)
       Dependency groups: dev

   # Show options for all repos in a group
   $ dbx install --show-options -g pymongo

   📦 Showing options for all repositories in group 'pymongo':

     mongo-python-driver:
       Extras: aws, encryption, test
       Dependency groups: dev, docs

     motor:
       Extras: test
       Dependency groups: dev

   # Show options for a specific group when repo exists in multiple groups
   $ dbx install mongo-python-driver --show-options -G langchain

   📦 mongo-python-driver

     Extras: langchain, test
     Dependency groups: (none)

The ``--show-options`` flag parses the ``pyproject.toml`` file(s) to extract:

- **Extras** from ``[project.optional-dependencies]``
- **Dependency groups** from ``[dependency-groups]`` (PEP 735)

You can combine ``--show-options`` with:

- ``-g <group>`` to show options for all repositories in a group
- ``-G <group>`` to specify which group's version of a repository to inspect when the same repository exists in multiple groups

Install Command Options
-----------------------

The ``install`` command uses ``uv pip install`` to install dependencies:

- ``-e`` / ``--extras``: Comma-separated list of extras to install (e.g., 'test', 'dev', 'aws')
- ``--dependency-groups``: Comma-separated list of dependency groups to install (e.g., 'dev', 'test')
- ``-g`` / ``--group``: Specify which group to use (useful when a repo exists in multiple groups)
- ``--show-options``: Show available extras and dependency groups without installing

This is useful when:

- You need to install dependencies for the first time
- Dependencies have been updated
- You want to install specific extras or dependency groups
- You're working with repositories that have multiple packages in sub-directories
- You want to see what options are available before installing

Requirements
------------

- The repository must be cloned first using ``dbx clone``
- The repository must have a ``pyproject.toml`` or ``setup.py``
- For repositories with sub-directories, each ``install_dirs`` directory must have a ``pyproject.toml`` or ``setup.py``