Skip to main content

Export conda env dependencies and pip requirements to ONE yml file.

Project description

Conda Env Export

https://img.shields.io/pypi/v/conda_env_export.svg https://api.travis-ci.com/luffy-yu/conda_env_export.svg?branch=master Documentation Status https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png

Export conda env dependencies and pip requirements to ONE yml file.

Features

  • Easy to use

  • Flexible options to export

  • Support Windows, Linux, and Mac

  • Remove duplicated packages automatically

Usage

To use Conda Env Export in a project:

import conda_env_export

To use Conda Env Export in a terminal:

$ conda-env-export --help
Usage: conda-env-export [OPTIONS]

Options:
  -n, --name TEXT           Name of environment  [default: `{activated}`]
  --conda-all               Output all conda deps  [default: False]
  --pip-all                 Output all pip deps  [default: False]
  --separate                Output to separate files  [default: False]
  --reserve-duplicates      Reserve duplicates  [default: False]
  --include TEXT            Force to include deps (ignore case)
  --exclude TEXT            Force to exclude deps (ignore case)
  --extra-pip-requirements  Output an extra `requirements.txt`  [default: False]
  --no-prefix               Remove `prefix` in target yml file  [default: False]
  --to-folder DIRECTORY     Where to output the file(s)  [default: ./]
  --to-file FILE            Filename of the output yml file  [default: `{activated}`]
  --help                    Show this message and exit.

[RECOMMEND]

Export current activated env, just run:

$ conda-env-export

[RECOMMEND]

Export a named env, e.g. py37, run:

$ conda-env-export -n py37

[RECOMMEND]

Export current activated env to separate files (activated.yml and requirements.txt), just run:

$ conda-env-export --separate

NOTE: –separate is different from –extra-pip-requirements in the output yml file, where the yml from –separate doesn’t explicitly list pip dependencies. It will use -r requirements.txt instead.

[RECOMMEND]

Export current activated env and output an EXTRA pip requirements file, just run:

$ conda-env-export --extra-pip-requirements

WHY: Sometimes it’ll fail to install some pip deps when executing conda env create -f env.yml, so it’s much more convenient to install pip deps via pip install -r requirements.txt rather than conda env update -f env.yml –prune.

Export a named env and ensure that output MUST include pip and PyYAML, run:

$ conda-env-export -n py37 --include pip --include pyyaml

Export a named env and ensure that output MUST exclude pip and PyYAML, run:

$ conda-env-export -n py37 --exclude pip --exclude pyyaml

Export with all conda deps and all pip deps of py37

$ conda-env-export -n py37 --conda-all --pip-all

Export with all conda deps and all pip deps of py37, and DO NOT remove duplicates

$ conda-env-export -n py37 --conda-all --pip-all --reserve-duplicates

Note: The operation of remove duplicates refers to remove those deps in pip, which are already in conda deps.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.5.0 (2024-02-05)

  • Fix https://github.com/luffy-yu/conda_env_export/issues/5 and https://github.com/luffy-yu/conda_env_export/issues/6

0.4.5 (2022-07-26)

  • Fix https://github.com/luffy-yu/conda_env_export/issues/3 and https://github.com/luffy-yu/conda_env_export/issues/4

0.4.4 (2022-07-18)

  • Fix https://github.com/luffy-yu/conda_env_export/issues/2

0.4.3 (2021-12-20)

  • Add python output in conda section

0.4.2 (2021-12-18)

  • Fix bugs in Windows

0.4.1 (2021-12-17)

  • Replace f’{}’ with ‘’%

0.4.0 (2021-12-17)

  • MAJOR UPDATE: Support Windows

0.3.2 (2021-04-14)

  • Add option: no-prefix.

0.3.1 (2021-03-07)

  • Update document.

0.3.0 (2021-03-07)

  • Add options: include and exclude.

  • Add option: extra-pip-requirements.

0.2.2 (2020-12-19)

  • Update document.

0.2.1 (2020-12-18)

  • Specify pip version.

0.2.0 (2020-12-05)

  • Refactor.

0.1.4 (2020-11-30)

  • Specify pyyaml verison.

0.1.3 (2020-11-29)

  • Fix typo.

0.1.2 (2020-11-29)

  • Overwrite PyPI verison.

0.1.1 (2020-11-29)

  • Update documents.

0.1.0 (2020-11-29)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

conda_env_export-0.5.0-py2.py3-none-any.whl (9.2 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page