Merge branch 'release/v0.10.0'

usnistgov · Nov 17, 2023 · 4a0af4e · 4a0af4e
2 parents 03110e6 + 49c5529
commit 4a0af4e
Show file tree

Hide file tree

Showing 33 changed files with 1,614 additions and 1,044 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,15 @@ See the fragment files in [changelog.d]
 
 <!-- scriv-insert-here -->
 
+## v0.10.0 — 2023-11-17
+
+### Added
+
+- Can now specify conda changes using `tool.pyproject2conda.dependencies` table.
+  This is an alternative to using `# p2c:` comments.
+- Refactored code. Split `parser` to `requirements` and `overrides`. Also
+  cleaned up the parsing logic to hopefully make future changes simpler.
+
 ## v0.9.0 — 2023-11-14
 
 ### Added

diff --git a/README.md b/README.md
@@ -132,14 +132,14 @@ Note the comment lines `# p2c:...`. These are special tokens that
 
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable-next-line MD013 -->
-<!-- [[[cog run_command("""python -c "from pyproject2conda.parser import _default_parser; _default_parser().parse_args(['--help'])" """, include_cmd=False, wrapper="bash")]]] -->
+<!-- [[[cog run_command("""python -c "from pyproject2conda.overrides import p2c_argparser; p2c_argparser().parse_args(['--help'])" """, include_cmd=False, wrapper="bash")]]] -->
 ```bash
-usage: -c [-h] [-c CHANNEL] [-p] [-s] [package ...]
+usage: -c [-h] [-c CHANNEL] [-p] [-s] [packages ...]
 
 Parser searches for comments '# p2c: [OPTIONS] CONDA-PACKAGES
 
 positional arguments:
-  package
+  packages
 
 options:
   -h, --help            show this help message and exit
@@ -195,6 +195,35 @@ dependencies:
 
 <!-- [[[end]]] -->
 
+### Alternate syntax: using table instead of comments
+
+While using comments to mark options has the convenience of placing the changes
+right next to the dependency, it can becore a bit cumbersome. If you feel this
+way, then you can use an alternative method to map `pip` dependencies to `conda`
+dependencies. For this, use the `tool.pyproject2.conda.dependencies` table. For
+example, we can do the same thing as above with:
+
+<!-- markdownlint-disable-next-line MD013 -->
+<!-- [[[cog cat_lines(path="tests/data/test-pyproject-alt.toml", begin="[tool.pyproject2conda.dependencies]", end="[tool.pyproject2conda.envs.base]")]]] -->
+
+```toml
+# ...
+[tool.pyproject2conda.dependencies]
+athing = { pip = true }
+bthing = { skip = true, packages = "bthing-conda" }
+cthing = { channel = "conda-forge" }
+pytest = { channel = "conda-forge" }
+matplotlib = { skip = true, packages = [
+  "additional-thing; python_version < '3.9'",
+  "conda-matplotlib"
+] }
+build = { channel = "pip" }
+# ...
+
+```
+
+<!-- [[[end]]] -->
+
 ### Specify python version
 
 To specify a specific value of python in the output, pass a value with:
@@ -454,8 +483,8 @@ dependencies:
 `pyproject2conda` can also be used within python:
 
 ```pycon
->>> from pyproject2conda import PyProject2Conda
->>> p = PyProject2Conda.from_path("./tests/data/test-pyproject.toml")
+>>> from pyproject2conda.requirements import ParseDepends
+>>> p = ParseDepends.from_path("./tests/data/test-pyproject.toml")
 
 # Basic environment
 >>> print(p.to_conda_yaml(python_include="infer").strip())
@@ -583,11 +612,11 @@ dependencies:
 or
 
 ```pycon
->>> from pyproject2conda import PyProject2Conda
->>> p = PyProject2Conda.from_path("./tests/data/test-pyproject.toml")
+>>> from pyproject2conda.requirements import ParseDepends
+>>> p = ParseDepends.from_path("./tests/data/test-pyproject.toml")
 
 # Basic environment
->>> print(p.to_conda_yaml(extras='dist-pypi', include_base_dependencies=False).strip())
+>>> print(p.to_conda_yaml(extras='dist-pypi', include_base=False).strip())
 channels:
   - conda-forge
 dependencies:
@@ -661,7 +690,7 @@ $ p2c project -f tests/data/test-pyproject.toml --dry
 # Creating requirements base.txt
 athing
 bthing
-cthing;python_version<'3.10'
+cthing;python_version<"3.10"
 # --------------------
 # Creating yaml py310-test-extras.yaml
 channels:

diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -19,7 +19,8 @@ Modules
    :toctree: generated/
    :template: autodocsumm/module.rst
 
-   parser
+   overrides
+   requirements
    config
    cli
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -28,7 +28,6 @@ dynamic = ["readme", "version"]
 requires-python = ">=3.8"
 dependencies = [
     "tomli",
-    "ruamel.yaml",
     "tomlkit",
     "typer",
     "packaging",
@@ -52,7 +51,7 @@ test = [
 ]
 dev-extras = [
     "setuptools-scm>=8.0", #
-    "pytest-accept", # p2c: -p
+    "pytest-accept",
     # "nbval",
     "ipython",
     "ipykernel",
@@ -66,11 +65,7 @@ typing = [
     "pyproject2conda[typing-extras]", #
     "pyproject2conda[test]",
 ]
-nox = [
-    "nox",
-    "noxopt", # p2c: -p
-    "ruamel.yaml",
-]
+nox = ["nox", "noxopt", "ruamel.yaml"]
 dev = [
     "pyproject2conda[test]", #
     "pyproject2conda[typing-extras]",
@@ -79,7 +74,7 @@ dev = [
 tools = [
     "pre-commit", #
     # "cruft",
-    "scriv", # p2c: -p
+    "scriv",
     "nbqa",
     "pyright",
 ]
@@ -112,6 +107,11 @@ dist-conda = [
 ]
 cog = ["cogapp"]
 
+[tool.pyproject2conda.dependencies]
+pytest-accept = { pip = true }
+noxopt = { pip = true }
+scriv = { pip = true }
+
 [tool.pyproject2conda]
 user_config = "config/userconfig.toml"
 template_python = "requirements/py{py}-{env}"

diff --git a/requirements/cog.txt b/requirements/cog.txt
@@ -9,8 +9,7 @@
 #
 cogapp
 packaging
-ruamel.yaml
 tomli
 tomlkit
 typer
-typing-extensions;python_version<'3.9'
+typing-extensions;python_version<"3.9"
diff --git a/requirements/dev-base.txt b/requirements/dev-base.txt
@@ -16,11 +16,10 @@ pytest-accept
 pytest-cov
 pytest-sugar
 pytest-xdist
-pytype;python_version<'3.11'
-ruamel.yaml
+pytype;python_version<"3.11"
 setuptools-scm>=8.0
 tomli
 tomlkit
 typer
 types-click
-typing-extensions;python_version<'3.9'
+typing-extensions;python_version<"3.9"
diff --git a/requirements/dev-complete.txt b/requirements/dev-complete.txt
@@ -21,12 +21,12 @@ pytest-accept
 pytest-cov
 pytest-sugar
 pytest-xdist
-pytype;python_version<'3.11'
+pytype;python_version<"3.11"
 ruamel.yaml
 scriv
 setuptools-scm>=8.0
 tomli
 tomlkit
 typer
 types-click
-typing-extensions;python_version<'3.9'
+typing-extensions;python_version<"3.9"
diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -18,11 +18,11 @@ pytest-accept
 pytest-cov
 pytest-sugar
 pytest-xdist
-pytype;python_version<'3.11'
+pytype;python_version<"3.11"
 ruamel.yaml
 setuptools-scm>=8.0
 tomli
 tomlkit
 typer
 types-click
-typing-extensions;python_version<'3.9'
+typing-extensions;python_version<"3.9"
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -13,7 +13,6 @@ ipython
 myst-nb
 packaging
 pyenchant
-ruamel.yaml
 sphinx-autobuild
 sphinx-book-theme
 sphinx-click
@@ -23,4 +22,4 @@ sphinxcontrib-spelling
 tomli
 tomlkit
 typer
-typing-extensions;python_version<'3.9'
+typing-extensions;python_version<"3.9"
diff --git a/requirements/py310-dev-base.yaml b/requirements/py310-dev-base.yaml
@@ -20,7 +20,6 @@ dependencies:
   - pytest-sugar
   - pytest-xdist
   - pytype
-  - ruamel.yaml
   - setuptools-scm>=8.0
   - tomli
   - tomlkit

diff --git a/requirements/py310-docs.yaml b/requirements/py310-docs.yaml
@@ -17,12 +17,11 @@ dependencies:
   - myst-nb
   - packaging
   - pyenchant
-  - ruamel.yaml
-  - sphinx>=5.3.0
   - sphinx-autobuild
   - sphinx-book-theme
   - sphinx-click
   - sphinx-copybutton
+  - sphinx>=5.3.0
   - sphinxcontrib-spelling
   - tomli
   - tomlkit

diff --git a/requirements/py310-test.yaml b/requirements/py310-test.yaml
@@ -16,7 +16,6 @@ dependencies:
   - pytest-cov
   - pytest-sugar
   - pytest-xdist
-  - ruamel.yaml
   - tomli
   - tomlkit
   - typer
diff --git a/requirements/py310-typing.yaml b/requirements/py310-typing.yaml
@@ -18,7 +18,6 @@ dependencies:
   - pytest-sugar
   - pytest-xdist
   - pytype
-  - ruamel.yaml
   - tomli
   - tomlkit
   - typer

diff --git a/requirements/py311-test.yaml b/requirements/py311-test.yaml
@@ -16,7 +16,6 @@ dependencies:
   - pytest-cov
   - pytest-sugar
   - pytest-xdist
-  - ruamel.yaml
   - tomli
   - tomlkit
   - typer
diff --git a/requirements/py311-typing.yaml b/requirements/py311-typing.yaml
@@ -17,7 +17,6 @@ dependencies:
   - pytest-cov
   - pytest-sugar
   - pytest-xdist
-  - ruamel.yaml
   - tomli
   - tomlkit
   - typer

diff --git a/requirements/py312-test.yaml b/requirements/py312-test.yaml
@@ -16,7 +16,6 @@ dependencies:
   - pytest-cov
   - pytest-sugar
   - pytest-xdist
-  - ruamel.yaml
   - tomli
   - tomlkit
   - typer
diff --git a/requirements/py312-typing.yaml b/requirements/py312-typing.yaml
@@ -17,7 +17,6 @@ dependencies:
   - pytest-cov
   - pytest-sugar
   - pytest-xdist
-  - ruamel.yaml
   - tomli
   - tomlkit
   - typer

diff --git a/requirements/py38-test.yaml b/requirements/py38-test.yaml
@@ -16,7 +16,6 @@ dependencies:
   - pytest-cov
   - pytest-sugar
   - pytest-xdist
-  - ruamel.yaml
   - tomli
   - tomlkit
   - typer

diff --git a/requirements/py38-typing.yaml b/requirements/py38-typing.yaml
@@ -18,7 +18,6 @@ dependencies:
   - pytest-sugar
   - pytest-xdist
   - pytype
-  - ruamel.yaml
   - tomli
   - tomlkit
   - typer

diff --git a/requirements/py39-test.yaml b/requirements/py39-test.yaml
@@ -16,7 +16,6 @@ dependencies:
   - pytest-cov
   - pytest-sugar
   - pytest-xdist
-  - ruamel.yaml
   - tomli
   - tomlkit
   - typer
diff --git a/requirements/py39-typing.yaml b/requirements/py39-typing.yaml
@@ -18,7 +18,6 @@ dependencies:
   - pytest-sugar
   - pytest-xdist
   - pytype
-  - ruamel.yaml
   - tomli
   - tomlkit
   - typer

diff --git a/requirements/test.txt b/requirements/test.txt
@@ -12,8 +12,7 @@ pytest
 pytest-cov
 pytest-sugar
 pytest-xdist
-ruamel.yaml
 tomli
 tomlkit
 typer
-typing-extensions;python_version<'3.9'
+typing-extensions;python_version<"3.9"
diff --git a/requirements/typing.txt b/requirements/typing.txt
@@ -13,10 +13,9 @@ pytest
 pytest-cov
 pytest-sugar
 pytest-xdist
-pytype;python_version<'3.11'
-ruamel.yaml
+pytype;python_version<"3.11"
 tomli
 tomlkit
 typer
 types-click
-typing-extensions;python_version<'3.9'
+typing-extensions;python_version<"3.9"
diff --git a/src/pyproject2conda/__init__.py b/src/pyproject2conda/__init__.py
@@ -10,13 +10,11 @@
 except PackageNotFoundError:  # pragma: no cover
     __version__ = "999"
 
-from .parser import PyProject2Conda
 
 __author__ = """William P. Krekelberg"""
 __email__ = "[email protected]"
 
 
 __all__ = [
     "__version__",
-    "PyProject2Conda",
 ]
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,7 +18,6 @@ dependencies: @@
       - pytest-sugar
       - pytest-xdist
       - pytype
-      - ruamel.yaml
       - tomli
       - tomlkit
       - typer
@@ Expand Down @@