Add recipe for xrst (extract rst files and run sphinx) #25198

bradbell · 2024-02-01T13:34:55Z

Purpose of xrst:
https://xrst.readthedocs.io/latest/purpose.html

Checklist

conda-forge-webservices · 2024-02-01T13:35:18Z

Hi! This is the friendly automated conda-forge-linting service.

I wanted to let you know that I linted all conda-recipes in your PR (recipes/xrst) and found some lint.

Here's what I've got...

For recipes/xrst:

Jinja2 variable definitions are suggested to take a {%<one space>set<one space><variable name><one space>=<one space><expression><one space>%} form. See lines [27, 29]

bradbell · 2024-02-02T15:23:49Z

There seems to be a problem with the conda-forge version of pyenchant that is caussing some of the test failures; see
conda-forge/pyenchant-feedstock#1
We will try changing the test of xrst to use pyspellchecker instead of pyenchant.

conda-forge-webservices · 2024-02-02T16:21:27Z

Hi! This is the friendly automated conda-forge-linting service.

I just wanted to let you know that I linted all conda-recipes in your PR (recipes/xrst) and found it was in an excellent condition.

Also remove pyenchant from requirements (not used by conda install).

remove dependency on pyenchant.

bradbell · 2024-02-06T12:31:28Z

I am convinced that the following commit truly passed the test on all the target systems: 0adf204

Waiting for feed back from the review team as per the instructions on
https://conda-forge.org/docs/maintainer/adding_pkgs.html
Once you finished your PR, all you have to do is wait for feedback from our review team.

bradbell · 2024-02-06T13:08:07Z

@conda-forge/help-python, ready for review.

bradbell · 2024-02-20T11:23:49Z

@conda-forge/help-python
It has been 2 weeks since this package passed all its tests and it does not yet have a review.

github-actions · 2024-02-20T11:24:02Z

To help direct your pull request to the best reviewers, please mention a topic-specifc team if your recipe matches any of the following: conda-forge/help-c-cpp, conda-forge/help-cdts, conda-forge/help-go, conda-forge/help-java, conda-forge/help-julia, conda-forge/help-nodejs, conda-forge/help-perl, conda-forge/help-python, conda-forge/help-python-c, conda-forge/help-r, conda-forge/help-ruby,or conda-forge/help-rust. Thanks!

dhirschfeld · 2024-03-23T07:52:24Z

recipes/xrst/2024.0.0.patch

+       'sphinx', 'toml', 'sphinx-copybutton',           # required
+       'pytest',                                        # need for testing xrst
+-      'pyenchant', 'pyspellchecker',                   # need the one you use
+      'pyspellchecker',                                # need the one you use


Since deps are specified in the meta.yaml it's not necessary to patch them in the setup.py... unless it's to enable pip check to work.

dhirschfeld

I don't think there are any issues which should prevent merging, however I don't have merge rights myself...

bradbell · 2024-03-23T13:25:52Z

The following text appears in meta.yaml:

build:
  entry_points:
    - xrst = xrst:run_xrst
  noarch: python
  script: {{ PYTHON }} -m pip install . -vv --no-deps --no-build-isolation
  number: 0

As I understand, the commands above instruct conda-forge to use pip to install the python files.
I therefore thought that I should make sure that pyproject.toml and setup.py do not require pyenchant because pip uses these files.

dhirschfeld · 2024-03-23T23:53:06Z

As I understand, the commands above instruct conda-forge to use pip to install the python files.

It uses pip to install just the package itself (it passes --no-deps automatically, even if you don't specify it https://github.com/conda/conda-build/blob/061063f10c51162707c7c5253daa39b2752fcfcc/conda_build/build.py#L3169-L3189)

The dependencies used are those specifiedin the meta.yaml. If they do happen to be different to what's in the upstream setup.py then pip check won't work so, sometimes it can be preferable to patch upstream dependencies but it's not necessary.

see conda-forge#25198

bradbell · 2024-03-24T12:31:13Z

Thanks for the clarification. I made the suggested changes; see
db29691

bradbell · 2024-04-03T12:30:51Z

I have been looking into fixing the pyenchant problem so that xrst can use it for a spell checker; see
conda-forge/hunspell-feedstock#12 (comment)

In any event, xrst will not be able to use pyenhant on windows because enchant is not available on windows; see
https://github.com/conda-forge/enchant-feedstock/blob/main/recipe/meta.yaml
where the following text appears:

build:
  number: 0
  skip: true  # [not unix]

So the solution here (not using pyenchant in the conda-forge install of xrst) may be the simplest because it makes xrst consistent for all platforms.

BastianZim · 2024-05-10T21:52:30Z

Can you please create your recipe with grayskull once and see if that passes? If it fails on windows because there is a missing dependency, you can just ignore that.

https://github.com/conda/grayskull
https://conda-forge.org/docs/maintainer/knowledge_base/#noarch-python

bradbell · 2024-05-11T11:50:06Z

I created a recipe for xrst using the command

grayskull pypi xrst

I then ran the command:

conda build xrst

and got the following error message:

ValueError: License file given in about/license_file (/home/bradbell/trash/conda/xrst/PLEASE_ADD_LICENSE_FILE) does not exist in source root dir or in recipe root dir (with meta.yaml)

Note that
https://github.com/conda-forge/staged-recipes/blob/main/recipes/example
suggests that one use SPDX identifiers for licenses.

Looking at
https://pypi.org/project/xrst/
you will see
License: OSI Approved (GPL-3.0-or-later)

As noted in at the top of xrst/meta.yaml, in the pull request:

# This project uses the SPDX identifier GPL-3.0-or-later; see
# https://spdx.org/licenses/GPL-3.0-or-later.html

BastianZim · 2024-05-14T16:03:07Z

PLEASE_ADD_LICENSE_FILE is not the actual license, this means that you need to add the license file into the folder. In practise, that means that you need to manually download the license file from the project website and add it to the folder where the meta.yaml is.

bradbell · 2024-05-14T17:08:02Z

In xrst/meta.yaml (generaged by grayskull) I changed
license_file: PLEASE_ADD_LICENSE_FILE to license_file: gpl-3.0.txt
and then executed

conda build xrst >& temp

If I execute grep ERROR temp I get

  ERROR setuptools_scm._file_finders.git listing git files failed - pretending there aren't any
  ERROR setuptools_scm._file_finders.git listing git files failed - pretending there aren't any

If I execute grep WARNING temp I get

WARNING: No numpy version specified in conda_build_config.yaml.  Falling back to default numpy value of 1.22

bradbell added 2 commits January 31, 2024 18:11

main: Initial recipe directory for conda-forge xrst.

31c0418

main: meta.yaml: Add comments about warning messages, python >= 3.8

999c2ba

main: patch xrst.toml because there is a bug in conda pyenchant.

b904101

bradbell added 6 commits February 2, 2024 11:52

main: xrst.toml: change test version, not version in source.

60348ad

main: Some fixes for runing on win_64.

356515d

main: remove pyenchant from install (see comments in meta.yaml).

c920b2f

main: split run_test.py into run_test.sh and run_test.bat.

80df5bc

Also remove pyenchant from requirements (not used by conda install).

main: fix sed command so work on mac, fix comments in dos script.

582a7f4

main: run_test.bat: fix so truely run the test,

0adf204

remove dependency on pyenchant.

github-actions bot added python review-requested labels Feb 6, 2024

github-actions bot added the staged-recipes label Feb 20, 2024

dhirschfeld reviewed Mar 23, 2024

View reviewed changes

dhirschfeld approved these changes Mar 23, 2024

View reviewed changes

Do not need to patch setup.py or pyproject.toml;

db29691

see conda-forge#25198

BastianZim removed staged-recipes review-requested labels May 10, 2024

github-actions bot added the Awaiting author contribution label May 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add recipe for xrst (extract rst files and run sphinx) #25198

Add recipe for xrst (extract rst files and run sphinx) #25198

bradbell commented Feb 1, 2024 •

edited

conda-forge-webservices bot commented Feb 1, 2024

bradbell commented Feb 2, 2024 •

edited

conda-forge-webservices bot commented Feb 2, 2024

bradbell commented Feb 6, 2024 •

edited

bradbell commented Feb 6, 2024

bradbell commented Feb 20, 2024 •

edited

github-actions bot commented Feb 20, 2024

dhirschfeld Mar 23, 2024

dhirschfeld left a comment

bradbell commented Mar 23, 2024 •

edited

dhirschfeld commented Mar 23, 2024

bradbell commented Mar 24, 2024

bradbell commented Apr 3, 2024 •

edited

BastianZim commented May 10, 2024

bradbell commented May 11, 2024 •

edited

BastianZim commented May 14, 2024

bradbell commented May 14, 2024

Add recipe for xrst (extract rst files and run sphinx) #25198

Are you sure you want to change the base?

Add recipe for xrst (extract rst files and run sphinx) #25198

Conversation

bradbell commented Feb 1, 2024 • edited

conda-forge-webservices bot commented Feb 1, 2024

bradbell commented Feb 2, 2024 • edited

conda-forge-webservices bot commented Feb 2, 2024

bradbell commented Feb 6, 2024 • edited

bradbell commented Feb 6, 2024

bradbell commented Feb 20, 2024 • edited

github-actions bot commented Feb 20, 2024

dhirschfeld Mar 23, 2024

Choose a reason for hiding this comment

dhirschfeld left a comment

Choose a reason for hiding this comment

bradbell commented Mar 23, 2024 • edited

dhirschfeld commented Mar 23, 2024

bradbell commented Mar 24, 2024

bradbell commented Apr 3, 2024 • edited

BastianZim commented May 10, 2024

bradbell commented May 11, 2024 • edited

BastianZim commented May 14, 2024

bradbell commented May 14, 2024

bradbell commented Feb 1, 2024 •

edited

bradbell commented Feb 2, 2024 •

edited

bradbell commented Feb 6, 2024 •

edited

bradbell commented Feb 20, 2024 •

edited

bradbell commented Mar 23, 2024 •

edited

bradbell commented Apr 3, 2024 •

edited

bradbell commented May 11, 2024 •

edited