==========
Kelvin SDK
==========

Welcome to the Kelvin SDK developer documentation.

The Kelvin SDK provides a command-line interface (CLI) and Python library for interacting
with the Kelvin platform. It enables developers to build, deploy, and manage applications
on the Kelvin ecosystem.

Getting Started
===============

Installation
------------

Install the Kelvin SDK using pip:

.. code-block:: bash

    pip install kelvin-sdk

For MLflow integration, install with the optional dependency:

.. code-block:: bash

    pip install kelvin-sdk[mlflow]

Authentication
--------------

After installation, authenticate with the Kelvin platform:

.. code-block:: bash

    kelvin auth login

You can specify a platform URL:

.. code-block:: bash

    kelvin auth login alpha.kelvininc.com

View Available Commands
-----------------------

Use the ``--tree`` flag to see all available commands:

.. code-block:: bash

    kelvin --tree

Get help for any command:

.. code-block:: bash

    kelvin --help
    kelvin app --help
    kelvin app create --help

CLI Reference
=============

.. toctree::
    :maxdepth: 2
    :caption: Command Line Interface

    modules/cli

Library Reference
=================

.. toctree::
    :maxdepth: 2
    :caption: Core Modules

    modules/core

.. toctree::
    :maxdepth: 2
    :caption: Commands Layer

    modules/commands

.. toctree::
    :maxdepth: 2
    :caption: Services Layer

    modules/services

.. toctree::
    :maxdepth: 2
    :caption: External Packages

    modules/krn

License
=======

.. toctree::
    :maxdepth: 1

    LICENSE

Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`