Metadata-Version: 2.1
Name: dvc-studio-client
Version: 0.21.0
Summary: Small library to post data from DVC/DVCLive to Iterative Studio 
Author-email: Iterative <support@dvc.org>
License: Apache-2.0
Project-URL: Issues, https://github.com/iterative/dvc-studio-client/issues
Project-URL: Source, https://github.com/iterative/dvc-studio-client
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Development Status :: 1 - Planning
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: dulwich
Requires-Dist: requests
Requires-Dist: voluptuous
Provides-Extra: dev
Requires-Dist: dvc-studio-client[docs,tests] ; extra == 'dev'
Requires-Dist: types-requests ; extra == 'dev'
Requires-Dist: mypy ==1.10.1 ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs <2,>=1.5.2 ; extra == 'docs'
Requires-Dist: mkdocs-gen-files <1,>=0.5.0 ; extra == 'docs'
Requires-Dist: mkdocs-material <10,>=9.3.1 ; extra == 'docs'
Requires-Dist: mkdocs-section-index <1,>=0.3.6 ; extra == 'docs'
Requires-Dist: mkdocstrings-python <2,>=1.6.3 ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest <9,>=7 ; extra == 'tests'
Requires-Dist: pytest-cov >=4.1.0 ; extra == 'tests'
Requires-Dist: pytest-sugar ; extra == 'tests'
Requires-Dist: pytest-mock ; extra == 'tests'

dvc-studio-client
=================

Client to interact with `DVC Studio`_.

|PyPI| |Status| |Python Version| |License|

|Tests| |Codecov| |pre-commit| |Black|

.. |PyPI| image:: https://img.shields.io/pypi/v/dvc-studio-client.svg
   :target: https://pypi.org/project/dvc-studio-client/
   :alt: PyPI
.. |Status| image:: https://img.shields.io/pypi/status/dvc-studio-client.svg
   :target: https://pypi.org/project/dvc-studio-client/
   :alt: Status
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/dvc-studio-client
   :target: https://pypi.org/project/dvc-studio-client
   :alt: Python Version
.. |License| image:: https://img.shields.io/pypi/l/dvc-studio-client
   :target: https://opensource.org/licenses/Apache-2.0
   :alt: License
.. |Tests| image:: https://github.com/iterative/dvc-studio-client/workflows/Tests/badge.svg
   :target: https://github.com/iterative/dvc-studio-client/actions?workflow=Tests
   :alt: Tests
.. |Codecov| image:: https://codecov.io/gh/iterative/dvc-studio-client/branch/main/graph/badge.svg
   :target: https://app.codecov.io/gh/iterative/dvc-studio-client
   :alt: Codecov
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
   :target: https://github.com/pre-commit/pre-commit
   :alt: pre-commit
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Black

Features
--------

- Model Registry
   - `get_download_uris`_: Return download URIs for the specified model.

- Live Experiments
   - `post_live_metrics`_: Post updates to `api/live`.

- Studio authentication
    - `get_access_token`_: Initiates the authentication process for a client application.

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

You can install *dvc-studio-client* via pip_ from PyPI_:

.. code:: console

   $ pip install dvc-studio-client

License
-------

Distributed under the terms of the `Apache 2.0 license`_,
*dvc-studio-client* is free and open source software.


Issues
------

If you encounter any problems,
please `file an issue`_ along with a detailed description.


.. _Apache 2.0 license: https://opensource.org/licenses/Apache-2.0
.. _PyPI: https://pypi.org/
.. _file an issue: https://github.com/iterative/dvc-studio-client/issues
.. _pip: https://pip.pypa.io/
.. github-only
.. _Contributor Guide: CONTRIBUTING.rst
.. _DVC Studio: https://dvc.org/doc/studio
.. _get_download_uris: https://docs.iterative.ai/dvc-studio-client/reference/dvc_studio_client/model_registry/
.. _post_live_metrics: https://docs.iterative.ai/dvc-studio-client/reference/dvc_studio_client/post_live_metrics/
.. _get_access_token: https://docs.iterative.ai/dvc-studio-client/reference/dvc_studio_client/auth/