pyproject2conda 0.1.2

A script to convert a Python project declared on a pyproject.toml to a conda environment.

pyproject2conda

A script to convert pyproject.toml dependecies to environemnt.yaml files.

Overview

The main goal of pyproject2conda is to provide a means to keep all basic dependency information, for both pip based and conda based environments, in pyproject.toml. I often use a mix of pip and conda when developing packages, and in my everyday workflow. Some packages just aren't available on both. If you use poetry, I'd highly recommend poetry2conda.

Features

• Simple comment based syntax to add information to dependencies when creating environment.yaml

Status

This package is actively used by the author, but is still very much a work in progress. Please feel free to create a pull request for wanted features and suggestions!

Quick start

Use one of the following

pip install pyproject2conda

or

conda install -c wpk-nist pyproject2conda

Example usage

Basic usage

Consider the toml file test-pyproject.toml.

[project]
name = "hello"
requires-python = ">=3.8,<3.11"
dependencies = [
  "athing", # p2c: -p # a comment
  "bthing", # p2c: -s bthing-conda
  "cthing", # p2c: -c conda-forge

]
# ...

Note the comment lines # p2c:.... These are special tokens that pyproject2conda will analyze. The basic options are:

Arguments:   Additional (conda) packages

-p --pip     Pip install pyproject package on this line.
-s --skip    Skip pyproject package on this line.
-c --channel Add channel to pyproject package on this line

So, if we run the following, we get:

$ pyproject2conda create -f test/test-pyproject.toml
channels:
  - conda-forge
dependencies:
  - bthing-conda
  - conda-forge::cthing
  - pip
  - pip:
      - athing

Note that other comments can be mixed in. This also works with extras. For example, with the following:

Also, by default, the python version is not included in the resulting conda output. To include the specification from pyproject.toml, use -p/--python option:

 ➜ pyproject2conda create -f tests/test-pyproject.toml -p
channels:
  - conda-forge
dependencies:
  - python>=3.8,<3.11
  - bthing-conda
  - conda-forge::cthing
  - pip
  - pip:
      - athing

To specify a value of python, pass a value with:

 ➜ pyproject2conda create -f tests/test-pyproject.toml -p python=3.9
channels:
  - conda-forge
dependencies:
  - python=3.9
  - bthing-conda
  - conda-forge::cthing
  - pip
  - pip:
      - athing

# ...
[project.optional-dependencies]
test = [
  "pandas",
  "pytest", # p2c: -c conda-forge

]
# ...

and running the the following gives:

$ pyproject2conda create -f tests/test-pyproject.toml test
channels:
  - conda-forge
dependencies:
  - bthing-conda
  - conda-forge::cthing
  - pandas
  - conda-forge::pytest
  - pip
  - pip:
      - athing

pyproject2conda also works with self referenced dependencies:

# ...
[project.optional-dependencies]
# ...
dev-extras = [
  # p2c: -s additional-thing # this is an additional conda package
  "matplotlib", # p2c: -s conda-matplotlib

]
dev = ["hello[test]", "hello[dev-extras]"]
# ...

$ pyproject2conda create -f tests/test-pyproject.toml dev
channels:
  - conda-forge
dependencies:
  - bthing-conda
  - conda-forge::cthing
  - pandas
  - conda-forge::pytest
  - additional-thing
  - conda-matplotlib
  - pip
  - pip:
      - athing

Usage within python

pyproject2conda can also be used within python:

>>> from pyproject2conda import PyProject2Conda
>>> p = PyProject2Conda.from_path("./tests/test-pyproject.toml")

# Basic environment
>>> print(p.to_conda_yaml(python="get").strip())
channels:
  - conda-forge
dependencies:
  - python>=3.8,<3.11
  - bthing-conda
  - conda-forge::cthing
  - pip
  - pip:
      - athing

# Environment with extras
>>> print(p.to_conda_yaml(extras="test").strip())
channels:
  - conda-forge
dependencies:
  - bthing-conda
  - conda-forge::cthing
  - pandas
  - conda-forge::pytest
  - pip
  - pip:
      - athing

Configuration

pyproject2conda can be configured with a [tool.pyproject2conda] section in pyproject.toml. To specify conda channels use:

# Why channel conda-forge appeared above
[tool.pyproject2conda]
channels = ["conda-forge"]

Note that specifying channels at the comand line overrides

You can also specify isolated-dependencies. These are dependencies for things that should not include package dependencies (things like build dependencies). For example:

[tool.pyproject2conda.isolated-dependencies]
dist-pypi = [
  "setuptools",
  "build", # p2c: -p

]

These can be accessed using either of the following:

$ pyproject2conda isolated -f tests/test-pyproject.toml dist-pypi
channels:
  - conda-forge
dependencies:
  - setuptools
  - pip
  - pip:
      - build

or

>>> from pyproject2conda import PyProject2Conda
>>> p = PyProject2Conda.from_path("./tests/test-pyproject.toml")

# Basic environment
>>> print(p.to_conda_yaml(isolated='dist-pypi').strip())
channels:
  - conda-forge
dependencies:
  - setuptools
  - pip
  - pip:
      - build

CLI options

 ➜ pyproject2conda --help

 Usage: pyproject2conda [OPTIONS] COMMAND [ARGS]...

╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --help      Show this message and exit.                                     │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────╮
│ create    Create yaml file from dependencies and optional-dependencies.     │
│ isolated  Create yaml file from                                             │
│           [tool.pyproject2conda.isolated-dependencies]                      │
│ list      List available extras/isolated                                    │
╰─────────────────────────────────────────────────────────────────────────────╯


 ➜ pyproject2conda list --help

 Usage: pyproject2conda list [OPTIONS]

 List available extras/isolated

╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --file     -f  PATH  input pyproject.toml file                              │
│ --verbose  -v                                                               │
│ --help               Show this message and exit.                            │
╰─────────────────────────────────────────────────────────────────────────────╯


 ➜ pyproject2conda create --help

 Usage: pyproject2conda create [OPTIONS] [EXTRAS]...

 Create yaml file from dependencies and optional-dependencies.

╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --channel  -c  TEXT  conda channel.  Can be specified multiple times.       │
│                      Overrides [tool.pyproject2conda.channels]              │
│ --file     -f  PATH  input pyproject.toml file                              │
│ --name     -n  TEXT  Name of conda env                                      │
│ --output   -o  PATH  File to output results                                 │
│ --python   -p  TEXT  if flag passed without options, include python spec    │
│                      from pyproject.toml in output.  If value passed, use   │
│                      this value of python in the output                     │
│ --help               Show this message and exit.                            │
╰─────────────────────────────────────────────────────────────────────────────╯


 ➜ pyproject2conda isolated --help

 Usage: pyproject2conda isolated [OPTIONS] ISOLATED...

 Create yaml file from [tool.pyproject2conda.isolated-dependencies]

╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --channel  -c  TEXT  conda channel.  Can be specified multiple times.       │
│                      Overrides [tool.pyproject2conda.channels]              │
│ --file     -f  PATH  input pyproject.toml file                              │
│ --name     -n  TEXT  Name of conda env                                      │
│ --output   -o  PATH  File to output results                                 │
│ --python   -p  TEXT  if flag passed without options, include python spec    │
│                      from pyproject.toml in output.  If value passed, use   │
│                      this value of python in the output                     │
│ --help               Show this message and exit.                            │
╰─────────────────────────────────────────────────────────────────────────────╯

License

This is free software. See LICENSE.

Related work

TBD

Contact

The author can be reached at [e-mail].

Credits

This package was created with Cookiecutter and the wpk-nist-gov/cookiecutter-pypackage Project template forked from audreyr/cookiecutter-pypackage.

Changelog

Changelog for pyproject2conda

Unreleased

See the fragment files in changelog.d

This software was developed by employees of the National Institute of Standards and Technology (NIST), an agency of the Federal Government. Pursuant to title 17 United States Code Section 105, works of NIST employees are not subject to copyright protection in the United States and are considered to be in the public domain. Permission to freely use, copy, modify, and distribute this software and its documentation without fee is hereby granted, provided that this notice and disclaimer of warranty appears in all copies.

THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.

Distributions of NIST software should also include copyright and licensing statements of any third-party software that are legally bundled with the code in compliance with the conditions of those licenses.