Metadata-Version: 2.1
Name: pyproject2conda
Version: 0.1.0
Summary: A script to convert a Python project declared on a pyproject.toml to a conda environment.
Author-email: "William P. Krekelberg" <wpk@nist.gov>
License: NIST-PD
Project-URL: homepage, https://github.com/wpk-nist-gov/pyproject2conda
Project-URL: documentation, https://pages.nist.gov/pyproject2conda/
Keywords: pyproject2conda
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: Public Domain
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: test
License-File: LICENSE

<!-- markdownlint-disable MD041 -->

[![Repo][repo-badge]][repo-link] [![Docs][docs-badge]][docs-link]
[![PyPI license][license-badge]][license-link]
[![PyPI version][pypi-badge]][pypi-link]
[![Conda (channel only)][conda-badge]][conda-link]
[![Code style: black][black-badge]][black-link]

<!--
  For more badges, see
  https://shields.io/category/other
  https://naereen.github.io/badges/
  [pypi-badge]: https://badge.fury.io/py/pyproject2conda
-->

[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[black-link]: https://github.com/psf/black
[pypi-badge]: https://img.shields.io/pypi/v/pyproject2conda
[pypi-link]: https://pypi.org/project/pyproject2conda
[docs-badge]: https://img.shields.io/badge/docs-sphinx-informational
[docs-link]: https://pages.nist.gov/pyproject2conda/
[repo-badge]: https://img.shields.io/badge/--181717?logo=github&logoColor=ffffff
[repo-link]: https://github.com/wpk-nist-gov/pyproject2conda
[conda-badge]: https://img.shields.io/conda/v/wpk-nist/pyproject2conda
[conda-link]: https://anaconda.org/wpk-nist/pyproject2conda
[license-badge]: https://img.shields.io/pypi/l/cmomy?color=informational
[license-link]:
  https://github.com/wpk-nist-gov/pyproject2conda/blob/main/LICENSE

<!-- other links -->

[poetry2conda]: https://github.com/dojeda/poetry2conda

# `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

```bash
pip install pyproject2conda
```

or

```bash
conda install -c wpk-nist pyproject2conda
```

## Example usage

### Basic usage

Consider the `toml` file [test-pyproject.toml](./tests/test-pyproject.toml).

```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:

```bash
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:

```bash
$ 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:

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

]
# ...

```

and running the the following gives:

```bash
$ 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:

```toml
# ...
[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]"]
# ...

```

```bash
$ 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:

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

# Basic environment
>>> print(p.to_conda_yaml().strip())
channels:
  - conda-forge
dependencies:
  - 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:

```toml
# 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:

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

]

```

These can be accessed using either of the following:

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

```

or

```pycon
>>> 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

```bash
 ➜ 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                                 │
│ --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                                 │
│ --help               Show this message and exit.                            │
╰─────────────────────────────────────────────────────────────────────────────╯

```

<!-- end-docs -->

<!-- ## Documentation -->

<!-- See the [documentation][docs-link] for a look at -->
<!-- `pyproject2conda` in action. -->

## License

This is free software. See [LICENSE][license-link].

## Related work

TBD

## Contact

The author can be reached at wpk@nist.gov.

## Credits

This package was created with
[Cookiecutter](https://github.com/audreyr/cookiecutter) and the
[wpk-nist-gov/cookiecutter-pypackage](https://github.com/wpk-nist-gov/cookiecutter-pypackage)
Project template forked from
[audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage).

# Changelog

Changelog for `pyproject2conda`

## Unreleased

See the fragment files in
[changelog.d](https://github.com/wpk-nist-gov/pyproject2conda)

<!-- scriv-insert-here -->

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.
