| Name | dvc-render JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | None |
| Summary | Dvc Render |
| upload_time | 2024-04-10 14:29:01 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
dvc-render
==========
|PyPI| |Status| |Python Version| |License|
|Tests| |Codecov| |pre-commit| |Black|
.. |PyPI| image:: https://img.shields.io/pypi/v/dvc-render.svg
:target: https://pypi.org/project/dvc-render/
:alt: PyPI
.. |Status| image:: https://img.shields.io/pypi/status/dvc-render.svg
:target: https://pypi.org/project/dvc-render/
:alt: Status
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/dvc-render
:target: https://pypi.org/project/dvc-render
:alt: Python Version
.. |License| image:: https://img.shields.io/pypi/l/dvc-render
:target: https://opensource.org/licenses/Apache-2.0
:alt: License
.. |Tests| image:: https://github.com/iterative/dvc-render/workflows/Tests/badge.svg
:target: https://github.com/iterative/dvc-render/actions?workflow=Tests
:alt: Tests
.. |Codecov| image:: https://codecov.io/gh/iterative/dvc-render/branch/main/graph/badge.svg
:target: https://app.codecov.io/gh/iterative/dvc-render
: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
dvc-render is a library for **rendering** data stored in `DVC plots format`_ into different output formats, like Vega_. It can also generate HTML and MarkDown **reports** containing multiple plots.
It is used internally by DVC_, DVCLive_, and Studio_.
Features
--------
* Renderers
Take data stored in `DVC plots format`_ alongside plot properties in order to render a plot in different formats.
* Reports
Take multiple renderers and build an HTML or MarkDown report.
* Templates
Support for rendering Vega_ plots using custom of pre-defined templates.
Requirements
------------
The basic usage of rendering Vega Plots doesn't have any dependencies outside
`Python>=3.8`.
Additional features are specified as optional requirements:
https://github.com/iterative/dvc-render/blob/49b8f8a81c4e06b8f675197b8dd57e2a773cf283/setup.cfg#L27-L32
Installation
------------
You can install *DVC render* via pip_ from PyPI_:
.. code:: console
$ pip install dvc-render
Usage
-----
* Renderer & Templates
.. code-block:: python
from dvc_render import VegaRenderer
properties = {"template": "confusion", "x": "predicted", "y": "actual"}
datapoints = [
{"predicted": "B", "actual": "A"},
{"predicted": "A", "actual": "A"},
]
renderer = VegaRenderer(datapoints, "foo", **properties)
plot_content = renderer.get_filled_template()
`plot_content` contains a valid Vega_ plot using the confusion matrix template.
* Report
.. code-block:: python
from dvc_render import render_html
render_html([renderer], "report.html")
Contributing
------------
Contributions are very welcome.
To learn more, see the `Contributor Guide`_.
License
-------
Distributed under the terms of the `Apache 2.0 license`_,
*DVC render* 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-render/issues
.. _pip: https://pip.pypa.io/
.. github-only
.. _Contributor Guide: CONTRIBUTING.rst
.. _DVC: https://github.com/iterative/dvc
.. _DVCLive: https://github.com/iterative/dvclive
.. _Studio: https://github.com/iterative/studio
.. _Vega: https://vega.github.io/
.. _`DVC plots format`: https://dvc.org/doc/user-guide/experiment-management/visualizing-plots#supported-plot-file-formats
Raw data
{
"_id": null,
"home_page": null,
"name": "dvc-render",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Iterative <support@dvc.org>",
"download_url": "https://files.pythonhosted.org/packages/be/15/605312dbdc0931547987ee25a9a3f6fcabf48ca1436039abcd524156b8e2/dvc-render-1.0.2.tar.gz",
"platform": null,
"description": "dvc-render\n==========\n\n|PyPI| |Status| |Python Version| |License|\n\n|Tests| |Codecov| |pre-commit| |Black|\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/dvc-render.svg\n :target: https://pypi.org/project/dvc-render/\n :alt: PyPI\n.. |Status| image:: https://img.shields.io/pypi/status/dvc-render.svg\n :target: https://pypi.org/project/dvc-render/\n :alt: Status\n.. |Python Version| image:: https://img.shields.io/pypi/pyversions/dvc-render\n :target: https://pypi.org/project/dvc-render\n :alt: Python Version\n.. |License| image:: https://img.shields.io/pypi/l/dvc-render\n :target: https://opensource.org/licenses/Apache-2.0\n :alt: License\n.. |Tests| image:: https://github.com/iterative/dvc-render/workflows/Tests/badge.svg\n :target: https://github.com/iterative/dvc-render/actions?workflow=Tests\n :alt: Tests\n.. |Codecov| image:: https://codecov.io/gh/iterative/dvc-render/branch/main/graph/badge.svg\n :target: https://app.codecov.io/gh/iterative/dvc-render\n :alt: Codecov\n.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\n :target: https://github.com/pre-commit/pre-commit\n :alt: pre-commit\n.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Black\n\ndvc-render is a library for **rendering** data stored in `DVC plots format`_ into different output formats, like Vega_. It can also generate HTML and MarkDown **reports** containing multiple plots.\n\nIt is used internally by DVC_, DVCLive_, and Studio_.\n\n\nFeatures\n--------\n\n* Renderers\n\nTake data stored in `DVC plots format`_ alongside plot properties in order to render a plot in different formats.\n\n* Reports\n\nTake multiple renderers and build an HTML or MarkDown report.\n\n* Templates\n\nSupport for rendering Vega_ plots using custom of pre-defined templates.\n\n\nRequirements\n------------\n\nThe basic usage of rendering Vega Plots doesn't have any dependencies outside\n`Python>=3.8`.\n\nAdditional features are specified as optional requirements:\n\nhttps://github.com/iterative/dvc-render/blob/49b8f8a81c4e06b8f675197b8dd57e2a773cf283/setup.cfg#L27-L32\n\n\nInstallation\n------------\n\nYou can install *DVC render* via pip_ from PyPI_:\n\n.. code:: console\n\n $ pip install dvc-render\n\n\nUsage\n-----\n\n* Renderer & Templates\n\n.. code-block:: python\n\n from dvc_render import VegaRenderer\n properties = {\"template\": \"confusion\", \"x\": \"predicted\", \"y\": \"actual\"}\n datapoints = [\n {\"predicted\": \"B\", \"actual\": \"A\"},\n {\"predicted\": \"A\", \"actual\": \"A\"},\n ]\n\n renderer = VegaRenderer(datapoints, \"foo\", **properties)\n plot_content = renderer.get_filled_template()\n\n`plot_content` contains a valid Vega_ plot using the confusion matrix template.\n\n* Report\n\n.. code-block:: python\n\n from dvc_render import render_html\n render_html([renderer], \"report.html\")\n\nContributing\n------------\n\nContributions are very welcome.\nTo learn more, see the `Contributor Guide`_.\n\n\nLicense\n-------\n\nDistributed under the terms of the `Apache 2.0 license`_,\n*DVC render* is free and open source software.\n\n\nIssues\n------\n\nIf you encounter any problems,\nplease `file an issue`_ along with a detailed description.\n\n\n.. _Apache 2.0 license: https://opensource.org/licenses/Apache-2.0\n.. _PyPI: https://pypi.org/\n.. _file an issue: https://github.com/iterative/dvc-render/issues\n.. _pip: https://pip.pypa.io/\n.. github-only\n.. _Contributor Guide: CONTRIBUTING.rst\n.. _DVC: https://github.com/iterative/dvc\n.. _DVCLive: https://github.com/iterative/dvclive\n.. _Studio: https://github.com/iterative/studio\n.. _Vega: https://vega.github.io/\n.. _`DVC plots format`: https://dvc.org/doc/user-guide/experiment-management/visualizing-plots#supported-plot-file-formats\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Dvc Render",
"version": "1.0.2",
"project_urls": {
"Issues": "https://github.com/iterative/dvc-render/issues",
"Source": "https://github.com/iterative/dvc-render"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "25e4d79fe332346a47b5468751292c0e45e496e10441e548ef447df1b6adb018",
"md5": "ad76eb6764ba556380f00f6f971cbd45",
"sha256": "7e3e3cec1200fda41a99984190f14871f3cb878db7f94c853305056f69614ddb"
},
"downloads": -1,
"filename": "dvc_render-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ad76eb6764ba556380f00f6f971cbd45",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 22070,
"upload_time": "2024-04-10T14:28:58",
"upload_time_iso_8601": "2024-04-10T14:28:58.351239Z",
"url": "https://files.pythonhosted.org/packages/25/e4/d79fe332346a47b5468751292c0e45e496e10441e548ef447df1b6adb018/dvc_render-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be15605312dbdc0931547987ee25a9a3f6fcabf48ca1436039abcd524156b8e2",
"md5": "d8508ad8f1e8050a31222e4bd18cab72",
"sha256": "40d1cd81760daf34b48fa8362b5002fcbe415e3cdbcf42369b6347d01497ffc0"
},
"downloads": -1,
"filename": "dvc-render-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "d8508ad8f1e8050a31222e4bd18cab72",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 37772,
"upload_time": "2024-04-10T14:29:01",
"upload_time_iso_8601": "2024-04-10T14:29:01.438127Z",
"url": "https://files.pythonhosted.org/packages/be/15/605312dbdc0931547987ee25a9a3f6fcabf48ca1436039abcd524156b8e2/dvc-render-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-10 14:29:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "iterative",
"github_project": "dvc-render",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "dvc-render"
}
