{"author":"Daniel R. D'Avella","author_email":"ddavella@stsci.edu","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Framework :: tox","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: Implementation :: CPython","Topic :: Software Development :: Testing"],"description":"tox-conda\n=========\n\n.. image:: https://www.repostatus.org/badges/latest/wip.svg\n :alt: Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.\n :target: https://www.repostatus.org/#wip\n\n.. image:: https://img.shields.io/pypi/v/tox-conda.svg\n :target: https://pypi.org/project/tox-conda\n :alt: PyPI version\n\n.. image:: https://img.shields.io/pypi/pyversions/tox-conda.svg\n :target: https://pypi.org/project/tox-conda\n :alt: Python versions\n\n.. image:: https://github.com/tox-dev/tox-conda/workflows/check/badge.svg\n :target: https://github.com/tox-dev/tox-conda/actions?query=workflow%3Acheck+branch%3Amaster\n :alt: CI\n\n.. image:: https://codecov.io/gh/tox-dev/tox-conda/branch/master/graph/badge.svg?token=yYBhrEf4MN\n :target: https://codecov.io/gh/tox-dev/tox-conda\n :alt: Code coverage\n\n``tox-conda`` is a plugin that provides integration with the `conda\n`_ package and environment manager for the `tox\n`__ automation tool. It's like having your cake and\neating it, too!\n\nBy default, ``tox`` creates isolated environments using `virtualenv\n`_ and installs dependencies from ``pip``.\n\nIn contrast, when using the ``tox-conda`` plugin ``tox`` will use ``conda`` to create\nenvironments, and will install specified dependencies from ``conda``. This is\nuseful for developers who rely on ``conda`` for environment management and\npackage distribution but want to take advantage of the features provided by\n``tox`` for test automation.\n\n``tox-conda`` has not been tested with ``conda`` version below 4.5.\n\nGetting Started\n---------------\n\n``tox-conda`` can be used in one of two ways: by installing it globally and by\nenabling it on a per-project basis. When the plugin is installed globally, the\ndefault behavior of ``tox`` will be to use ``conda`` to create environments. To\nuse it on a per-project basis instead, use ``tox``'s auto-provisioning feature\nto selectively enable the plugin.\n\nTo enable the use of ``tox-conda`` by default, follow the `Installation`_\ninstructions. To use the plugin selectively, do not manually install it, but\ninstead enable it by adding ``tox-conda`` as a provisioning requirement to a\nproject's ``tox`` config:\n\n::\n\n [tox]\n requires = tox-conda\n\nMore information on auto-provisioning can be found in the `tox documentation\n`__.\n\nInstallation\n------------\n\nThe ``tox-conda`` package is available on ``pypi``. To install, simply use the\nfollowing command:\n\n::\n\n $ pip install tox-conda\n\nTo install from source, first clone the project from `github\n`_:\n\n::\n\n $ git clone https://github.com/tox-dev/tox-conda\n\nThen install it in your environment:\n\n::\n\n $ cd tox-conda\n $ pip install .\n\nTo install in `development\nmode `__::\n\n $ pip install -e .\n\nThe ``tox-conda`` plugin expects that ``tox`` and ``conda`` are already installed and\navailable in your working environment.\n\nUsage\n-----\n\nDetails on ``tox`` usage can be found in the `tox documentation\n`_.\n\nWith the plugin enabled and no other changes, the ``tox-conda`` plugin will use\n``conda`` to create environments and use ``pip`` to install dependencies that are\ngiven in the ``tox.ini`` configuration file.\n\n``tox-conda`` adds four additional (and optional) settings to the ``[testenv]``\nsection of configuration files:\n\n* ``conda_deps``, which is used to configure which dependencies are installed\n from ``conda`` instead of from ``pip``. All dependencies in ``conda_deps`` are\n installed before all dependencies in ``deps``. If not given, no dependencies\n will be installed using ``conda``.\n\n* ``conda_channels``, which specifies which channel(s) should be used for\n resolving ``conda`` dependencies. If not given, only the ``default`` channel will\n be used.\n\n* ``conda_spec``, which specifies a ``conda-spec.txt`` file that lists conda\n dependencies to install and will be combined with ``conda_deps`` (if given). These\n dependencies can be in a general from (e.g., ``numpy>=1.17.5``) or an explicit\n form (eg., https://conda.anaconda.org/conda-forge/linux-64/numpy-1.17.5-py38h95a1406_0.tar.bz2),\n *however*, if the ``@EXPLICIT`` header is in ``conda-spec.txt``, *all* general\n dependencies will be ignored, including those given in ``conda_deps``.\n\n* ``conda_env``, which specifies a ``conda-env.yml`` file to create a base conda\n environment for the test. The ``conda-env.yml`` file is self-contained and\n if the desired conda channels to use are not given, the default channels will be used.\n If the ``conda-env.yml`` specifies a python version it must be compatible with the ``basepython``\n set for the tox env. A ``conda-env.yml`` specifying ``python>=3.8`` could for example be\n used with ``basepython`` set to ``py38``, ``py39`` or ``py310``.\n The above ``conda_deps``, ``conda_channels``, and ``conda_spec`` arguments, if used in\n conjunction with a ``conda-env.yml`` file, will be used to *update* the environment *after* the\n initial environment creation.\n\n* ``conda_create_args``, which is used to pass arguments to the command ``conda create``.\n The passed arguments are inserted in the command line before the python package.\n For instance, passing ``--override-channels`` will create more reproducible environments\n because the channels defined in the user's ``.condarc`` will not interfer.\n\n* ``conda_install_args``, which is used to pass arguments to the command ``conda install``.\n The passed arguments are inserted in the command line before the dependencies.\n For instance, passing ``--override-channels`` will create more reproducible environments\n because the channels defined in the user's ``.condarc`` will not interfer.\n\n* If `mamba `_ is installed in the same environment as tox,\n you may use it instead of the ``conda`` executable by setting the environment variable\n ``CONDA_EXE=mamba`` in the shell where ``tox`` is called.\n\nAn example configuration file is given below:\n\n::\n\n [tox]\n envlist =\n {py35,py36,py37}-{stable,dev}\n\n [testenv]\n deps=\n pytest-sugar\n py35,py36: importlib_resources\n dev: git+git://github.com/numpy/numpy\n conda_deps=\n pytest<=3.8\n stable: numpy=1.15\n conda_channels=\n conda-forge\n conda_install_args=\n --override-channels\n commands=\n pytest {posargs}\n\nMore information on ``tox`` configuration files can be found in the\n`documentation `_.\n\nContributing\n------------\nContributions are very welcome. Tests can be run with `tox`_, please ensure\nthe coverage at least stays the same before you submit a pull request.\n\nLicense\n-------\n\nDistributed under the terms of the `MIT`_ license, \"tox-conda\" is free and open source software\n\nIssues\n------\n\nIf you encounter any problems, please `file an issue`_ along with a detailed description.\n\n.. _`Cookiecutter`: https://github.com/audreyr/cookiecutter\n.. _`@obestwalter`: https://github.com/tox-dev\n.. _`MIT`: http://opensource.org/licenses/MIT\n.. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause\n.. _`GNU GPL v3.0`: http://www.gnu.org/licenses/gpl-3.0.txt\n.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0\n.. _`cookiecutter-tox-plugin`: https://github.com/tox-dev/cookiecutter-tox-plugin\n.. _`file an issue`: https://github.com/tox-dev/tox-conda/issues\n.. _`pytest`: https://github.com/pytest-dev/pytest\n.. _`tox`: https://tox.readthedocs.io/en/latest/\n.. _`pip`: https://pypi.org/project/pip/\n.. _`PyPI`: https://pypi.org\n","description_content_type":"text/x-rst","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/tox-dev/tox-conda","keywords":"","license":"MIT","license_expression":null,"license_files":null,"maintainer":"Bernat Gabor","maintainer_email":"gaborjbernat@gmail.com","name":"tox-conda","package_url":"https://pypi.org/project/tox-conda/","platform":null,"project_url":"https://pypi.org/project/tox-conda/","project_urls":{"Homepage":"https://github.com/tox-dev/tox-conda"},"provides_extra":null,"release_url":"https://pypi.org/project/tox-conda/0.10.2/","requires_dist":["ruamel.yaml (<0.18,>=0.15.0)","tox (<4,>=3.8.1)"],"requires_python":">=3.5","summary":"tox plugin that provides integration with conda","version":"0.10.2","yanked":false,"yanked_reason":null}

Dependencies of tox-conda (2).
Dependency	Optional
ruamel.yaml	false
tox	false

Package search

tox-conda

project_urls

Dependencies

All package metadata

Releases