:py:mod:`environment_yml`
=========================

.. py:module:: conda.plugins.environment_exporters.environment_yml

.. autoapi-nested-parse::

   Built-in conda standard environment exporter plugins (YAML and JSON).




Functions
---------

.. autoapisummary::

   conda.plugins.environment_exporters.environment_yml.to_dict
   conda.plugins.environment_exporters.environment_yml.export_yaml
   conda.plugins.environment_exporters.environment_yml.export_json
   conda.plugins.environment_exporters.environment_yml.conda_environment_exporters



Attributes
----------

.. autoapisummary::

   conda.plugins.environment_exporters.environment_yml.ENVIRONMENT_JSON_FORMAT
   conda.plugins.environment_exporters.environment_yml.ENVIRONMENT_YAML_FORMAT
   conda.plugins.environment_exporters.environment_yml.EnvironmentFormatType


.. py:data:: ENVIRONMENT_JSON_FORMAT
   :type:  Final
   :value: 'environment-json'


   The name of the environment-json format.

.. py:data:: ENVIRONMENT_YAML_FORMAT
   :type:  Final
   :value: 'environment-yaml'


   The name of the environment-yaml format.

.. py:data:: EnvironmentFormatType

   Type alias for format validation.

.. py:function:: to_dict(env: conda.models.environment.Environment) -> dict[str, Any]

   Convert Environment to standard dictionary format used by YAML and JSON exporters.

   This represents the common dictionary structure that both YAML and JSON
   environment formats use.

   :param env: Environment model to convert

   :returns: Dictionary with standard environment fields


.. py:function:: export_yaml(env: conda.models.environment.Environment) -> str

   Export Environment to YAML format.


.. py:function:: export_json(env: conda.models.environment.Environment) -> str

   Export Environment to JSON format.


.. py:function:: conda_environment_exporters()

   Register the built-in YAML and JSON environment exporters.