Bug 2278424 - Review Request: myst-nb - Jupyter Notebook Sphinx reader
Summary: Review Request: myst-nb - Jupyter Notebook Sphinx reader
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Zbigniew Jędrzejewski-Szmek
QA Contact: Fedora Extras Quality Assurance
URL: https://myst-nb.readthedocs.io/
Whiteboard:
Depends On: 2278423
Blocks: 2271129
TreeView+ depends on / blocked
 
Reported: 2024-05-01 20:25 UTC by Jerry James
Modified: 2024-07-31 02:45 UTC (History)
3 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2024-07-31 02:45:21 UTC
Type: ---
Embargoed:
zbyszek: fedora-review+


Attachments (Terms of Use)

Description Jerry James 2024-05-01 20:25:56 UTC
Spec URL: https://jjames.fedorapeople.org/python-myst-nb/python-myst-nb.spec
SRPM URL: https://jjames.fedorapeople.org/python-myst-nb/python-myst-nb-1.1.0-1.fc41.src.rpm
Fedora Account System Username: jjames
Description: MyST is a rich and extensible flavor of Markdown meant for technical documentation and publishing.  It is designed for simplicity, flexibility, and extensibility.  This package contains a reference implementation of MyST Markdown, as well as a collection of tools to support working with MyST in Python and Sphinx.  It contains an extended CommonMark-compliant parser using markdown-it-py, as well as a Sphinx extension that allows you to write MyST Markdown in Sphinx.

See https://copr.fedorainfracloud.org/coprs/jjames/Jupyter/ for builds of this package.

I am willing to swap reviews.

Comment 1 Fedora Review Service 2024-05-01 20:28:29 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/7397096
(failed)

Build log:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2278424-python-myst-nb/fedora-rawhide-x86_64/07397096-python-myst-nb/builder-live.log.gz

Please make sure the package builds successfully at least for Fedora Rawhide.

- If the build failed for unrelated reasons (e.g. temporary network
  unavailability), please ignore it.
- If the build failed because of missing BuildRequires, please make sure they
  are listed in the "Depends On" field


---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 2 Robert-André Mauchin 🐧 2024-05-22 10:52:23 UTC
- License is unclear, I opened a bug report: https://github.com/executablebooks/MyST-NB/issues/602

 - Use pytest for tests are %tox is not running them"

BuildRequires:  python3-pytest

%if %{with test}
%check
%pytest
%endif

Some will fail. Most likely due too matplotlib being newer than the one expected upstream.
Disable the failing test with -k, and report the bug upstream:

+ /usr/bin/pytest
============================= test session starts ==============================
platform linux -- Python 3.12.3, pytest-7.4.3, pluggy-1.3.0
rootdir: /builddir/build/BUILD/MyST-NB-1.1.0
configfile: tox.ini
plugins: anyio-3.7.1, datadir-1.5.0, regressions-2.5.0, cov-4.0.0, pytest_param_files-0.3.4
collected 80 items
tests/test_ansi_lexer.py ...........                                     [ 13%]
tests/test_cli.py ..                                                     [ 16%]
tests/test_codecell_file.py ..                                           [ 18%]
tests/test_docutils.py ..............                                    [ 36%]
tests/test_eval.py .                                                     [ 37%]
tests/test_execute.py .............FF........FF                          [ 68%]
tests/test_glue.py .....                                                 [ 75%]
tests/test_parser.py ....                                                [ 80%]
tests/test_render_outputs.py .............                               [ 96%]
tests/test_text_based.py ...                                             [100%]
=================================== FAILURES ===================================
_______________________ test_complex_outputs_unrun_cache _______________________
sphinx_run = <conftest.SphinxFixture object at 0x7f7abd3a9a30>
file_regression = <conftest.FileRegression object at 0x7f7abd400ec0>
check_nbs = <function check_nbs.<locals>._check_nbs at 0x7f7abd3fb920>
    @pytest.mark.sphinx_params(
        "complex_outputs_unrun.ipynb", conf={"nb_execution_mode": "cache"}
    )
    def test_complex_outputs_unrun_cache(sphinx_run, file_regression, check_nbs):
        sphinx_run.build()
        # print(sphinx_run.status())
        assert sphinx_run.warnings() == ""
>       regress_nb_doc(file_regression, sphinx_run, check_nbs)
/builddir/build/BUILD/MyST-NB-1.1.0/tests/test_execute.py:216: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
/builddir/build/BUILD/MyST-NB-1.1.0/tests/test_execute.py:37: in regress_nb_doc
    file_regression.check(doctree_string, extension=".xml", encoding="utf-8")
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
self = <conftest.FileRegression object at 0x7f7abd400ec0>
data = '<document source="complex_outputs_unrun" translation_progress="{\'total\': 0, \'translated\': 0}">\n    <container ce...             <emphasis>\n                                        some\n                                     markdown\n'
kwargs = {'encoding': 'utf-8', 'extension': '.xml'}
    def check(self, data, **kwargs):
>       return self.file_regression.check(self._strip_ignores(data), **kwargs)
E       AssertionError: FILES DIFFER:
E       /tmp/pytest-of-mockbuild/pytest-0/test_complex_outputs_unrun_cac0/test_execute/test_complex_outputs_unrun_cache.xml
E       /tmp/pytest-of-mockbuild/pytest-0/test_complex_outputs_unrun_cac0/test_execute/test_complex_outputs_unrun_cache.obtained.xml
E       HTML DIFF: /tmp/pytest-of-mockbuild/pytest-0/test_complex_outputs_unrun_cac0/test_execute/test_complex_outputs_unrun_cache.obtained.diff.html
E       --- 
E       +++ 
E       @@ -214,7 +214,7 @@
E                                    (√5⋅ⅈ)      ⋅⎜─ - ──────⎟ + (-√5⋅ⅈ)      ⋅⎜─ + ──────⎟
E                                                 ⎝2     5   ⎠                 ⎝2     5   ⎠
E                            <container mime_type="image/png">
E       -                        <image candidates="{'*': '_build/jupyter_execute/9bc81205a14646a235d284d1b68223d17f30f7f1d3d8ed3e52cf47830b02e3bb.png'}" uri="_build/jupyter_execute/9bc81205a14646a235d284d1b68223d17f30f7f1d3d8ed3e52cf47830b02e3bb.png">
E       +                        <image candidates="{'*': '_build/jupyter_execute/fd9ed1ea43d887584ea600fa27ca630752bf6f02d767def5675bcd5114ad03ba.png'}" uri="_build/jupyter_execute/fd9ed1ea43d887584ea600fa27ca630752bf6f02d767def5675bcd5114ad03ba.png">
E                            <container mime_type="text/latex">
E                                <math_block classes="output text_latex" nowrap="False" number="True" xml:space="preserve">
E                                    \displaystyle \left(\sqrt{5} i\right)^{\alpha} \left(\frac{1}{2} - \frac{2 \sqrt{5} i}{5}\right) + \left(- \sqrt{5} i\right)^{\alpha} \left(\frac{1}{2} + \frac{2 \sqrt{5} i}{5}\right)
/builddir/build/BUILD/MyST-NB-1.1.0/tests/conftest.py:286: AssertionError
----------------------------- Captured stderr call -----------------------------
[IPKernelApp] WARNING | debugpy_stream undefined, debugging will not be enabled
_______________________ test_complex_outputs_unrun_auto ________________________
sphinx_run = <conftest.SphinxFixture object at 0x7f7abd3208c0>
file_regression = <conftest.FileRegression object at 0x7f7abd2fa9c0>
check_nbs = <function check_nbs.<locals>._check_nbs at 0x7f7abd33db20>
    @pytest.mark.sphinx_params(
        "complex_outputs_unrun.ipynb", conf={"nb_execution_mode": "auto"}
    )
    def test_complex_outputs_unrun_auto(sphinx_run, file_regression, check_nbs):
        sphinx_run.build()
        # print(sphinx_run.status())
        assert sphinx_run.warnings() == ""
>       regress_nb_doc(file_regression, sphinx_run, check_nbs)
/builddir/build/BUILD/MyST-NB-1.1.0/tests/test_execute.py:237: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
/builddir/build/BUILD/MyST-NB-1.1.0/tests/test_execute.py:37: in regress_nb_doc
    file_regression.check(doctree_string, extension=".xml", encoding="utf-8")
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
self = <conftest.FileRegression object at 0x7f7abd2fa9c0>
data = '<document source="complex_outputs_unrun" translation_progress="{\'total\': 0, \'translated\': 0}">\n    <container ce...             <emphasis>\n                                        some\n                                     markdown\n'
kwargs = {'encoding': 'utf-8', 'extension': '.xml'}
    def check(self, data, **kwargs):
>       return self.file_regression.check(self._strip_ignores(data), **kwargs)
E       AssertionError: FILES DIFFER:
E       /tmp/pytest-of-mockbuild/pytest-0/test_complex_outputs_unrun_aut0/test_execute/test_complex_outputs_unrun_auto.xml
E       /tmp/pytest-of-mockbuild/pytest-0/test_complex_outputs_unrun_aut0/test_execute/test_complex_outputs_unrun_auto.obtained.xml
E       HTML DIFF: /tmp/pytest-of-mockbuild/pytest-0/test_complex_outputs_unrun_aut0/test_execute/test_complex_outputs_unrun_auto.obtained.diff.html
E       --- 
E       +++ 
E       @@ -214,7 +214,7 @@
E                                    (√5⋅ⅈ)      ⋅⎜─ - ──────⎟ + (-√5⋅ⅈ)      ⋅⎜─ + ──────⎟
E                                                 ⎝2     5   ⎠                 ⎝2     5   ⎠
E                            <container mime_type="image/png">
E       -                        <image candidates="{'*': '_build/jupyter_execute/9bc81205a14646a235d284d1b68223d17f30f7f1d3d8ed3e52cf47830b02e3bb.png'}" uri="_build/jupyter_execute/9bc81205a14646a235d284d1b68223d17f30f7f1d3d8ed3e52cf47830b02e3bb.png">
E       +                        <image candidates="{'*': '_build/jupyter_execute/fd9ed1ea43d887584ea600fa27ca630752bf6f02d767def5675bcd5114ad03ba.png'}" uri="_build/jupyter_execute/fd9ed1ea43d887584ea600fa27ca630752bf6f02d767def5675bcd5114ad03ba.png">
E                            <container mime_type="text/latex">
E                                <math_block classes="output text_latex" nowrap="False" number="True" xml:space="preserve">
E                                    \displaystyle \left(\sqrt{5} i\right)^{\alpha} \left(\frac{1}{2} - \frac{2 \sqrt{5} i}{5}\right) + \left(- \sqrt{5} i\right)^{\alpha} \left(\frac{1}{2} + \frac{2 \sqrt{5} i}{5}\right)
/builddir/build/BUILD/MyST-NB-1.1.0/tests/conftest.py:286: AssertionError
----------------------------- Captured stderr call -----------------------------
[IPKernelApp] WARNING | debugpy_stream undefined, debugging will not be enabled
___________________________ test_custom_convert_auto ___________________________
sphinx_run = <conftest.SphinxFixture object at 0x7f7abd3a9e80>
file_regression = <conftest.FileRegression object at 0x7f7abd3afa40>
check_nbs = <function check_nbs.<locals>._check_nbs at 0x7f7abd28c360>
    @pytest.mark.sphinx_params(
        "custom-formats.Rmd",
        conf={
            "nb_execution_mode": "auto",
            "nb_custom_formats": {".Rmd": ["jupytext.reads", {"fmt": "Rmd"}]},
        },
    )
    def test_custom_convert_auto(sphinx_run, file_regression, check_nbs):
        sphinx_run.build()
        # print(sphinx_run.status())
        assert sphinx_run.warnings() == ""
>       regress_nb_doc(file_regression, sphinx_run, check_nbs)
/builddir/build/BUILD/MyST-NB-1.1.0/tests/test_execute.py:341: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
/builddir/build/BUILD/MyST-NB-1.1.0/tests/test_execute.py:37: in regress_nb_doc
    file_regression.check(doctree_string, extension=".xml", encoding="utf-8")
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
self = <conftest.FileRegression object at 0x7f7abd3afa40>
data = '<document source="custom-formats" translation_progress="{\'total\': 0, \'translated\': 0}">\n    <section ids="custom...a5d7c3924be9.png" uri="_build/jupyter_execute/d4af8d3724871916ca3dad388b7031ac3493074b53430101d6cea5d7c3924be9.png">\n'
kwargs = {'encoding': 'utf-8', 'extension': '.xml'}
    def check(self, data, **kwargs):
>       return self.file_regression.check(self._strip_ignores(data), **kwargs)
E       AssertionError: FILES DIFFER:
E       /tmp/pytest-of-mockbuild/pytest-0/test_custom_convert_auto0/test_execute/test_custom_convert_auto.xml
E       /tmp/pytest-of-mockbuild/pytest-0/test_custom_convert_auto0/test_execute/test_custom_convert_auto.obtained.xml
E       HTML DIFF: /tmp/pytest-of-mockbuild/pytest-0/test_custom_convert_auto0/test_execute/test_custom_convert_auto.obtained.diff.html
E       --- 
E       +++ 
E       @@ -18,4 +18,4 @@
E                                <literal_block classes="output text_plain" language="myst-ansi" xml:space="preserve">
E                                    <Figure size 640x480 with 1 Axes>
E                            <container mime_type="image/png">
E       -                        <image candidates="{'*': '_build/jupyter_execute/a2e637020dfe58f670ba2c942d7a55e49ba48bed09312569ee15a84f5ac680cb.png'}" uri="_build/jupyter_execute/a2e637020dfe58f670ba2c942d7a55e49ba48bed09312569ee15a84f5ac680cb.png">
E       +                        <image candidates="{'*': '_build/jupyter_execute/d4af8d3724871916ca3dad388b7031ac3493074b53430101d6cea5d7c3924be9.png'}" uri="_build/jupyter_execute/d4af8d3724871916ca3dad388b7031ac3493074b53430101d6cea5d7c3924be9.png">
/builddir/build/BUILD/MyST-NB-1.1.0/tests/conftest.py:286: AssertionError
----------------------------- Captured stderr call -----------------------------
[IPKernelApp] WARNING | debugpy_stream undefined, debugging will not be enabled
__________________________ test_custom_convert_cache ___________________________
sphinx_run = <conftest.SphinxFixture object at 0x7f7abd7bb4a0>
file_regression = <conftest.FileRegression object at 0x7f7abd6f4890>
check_nbs = <function check_nbs.<locals>._check_nbs at 0x7f7abd2b3880>
    @pytest.mark.sphinx_params(
        "custom-formats.Rmd",
        conf={
            "nb_execution_mode": "cache",
            "nb_custom_formats": {".Rmd": ["jupytext.reads", {"fmt": "Rmd"}]},
        },
    )
    def test_custom_convert_cache(sphinx_run, file_regression, check_nbs):
        """The outputs should be populated."""
        sphinx_run.build()
        assert sphinx_run.warnings() == ""
>       regress_nb_doc(file_regression, sphinx_run, check_nbs)
/builddir/build/BUILD/MyST-NB-1.1.0/tests/test_execute.py:361: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
/builddir/build/BUILD/MyST-NB-1.1.0/tests/test_execute.py:37: in regress_nb_doc
    file_regression.check(doctree_string, extension=".xml", encoding="utf-8")
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
self = <conftest.FileRegression object at 0x7f7abd6f4890>
data = '<document source="custom-formats" translation_progress="{\'total\': 0, \'translated\': 0}">\n    <section ids="custom...a5d7c3924be9.png" uri="_build/jupyter_execute/d4af8d3724871916ca3dad388b7031ac3493074b53430101d6cea5d7c3924be9.png">\n'
kwargs = {'encoding': 'utf-8', 'extension': '.xml'}
    def check(self, data, **kwargs):
>       return self.file_regression.check(self._strip_ignores(data), **kwargs)
E       AssertionError: FILES DIFFER:
E       /tmp/pytest-of-mockbuild/pytest-0/test_custom_convert_cache0/test_execute/test_custom_convert_cache.xml
E       /tmp/pytest-of-mockbuild/pytest-0/test_custom_convert_cache0/test_execute/test_custom_convert_cache.obtained.xml
E       HTML DIFF: /tmp/pytest-of-mockbuild/pytest-0/test_custom_convert_cache0/test_execute/test_custom_convert_cache.obtained.diff.html
E       --- 
E       +++ 
E       @@ -18,4 +18,4 @@
E                                <literal_block classes="output text_plain" language="myst-ansi" xml:space="preserve">
E                                    <Figure size 640x480 with 1 Axes>
E                            <container mime_type="image/png">
E       -                        <image candidates="{'*': '_build/jupyter_execute/a2e637020dfe58f670ba2c942d7a55e49ba48bed09312569ee15a84f5ac680cb.png'}" uri="_build/jupyter_execute/a2e637020dfe58f670ba2c942d7a55e49ba48bed09312569ee15a84f5ac680cb.png">
E       +                        <image candidates="{'*': '_build/jupyter_execute/d4af8d3724871916ca3dad388b7031ac3493074b53430101d6cea5d7c3924be9.png'}" uri="_build/jupyter_execute/d4af8d3724871916ca3dad388b7031ac3493074b53430101d6cea5d7c3924be9.png">
/builddir/build/BUILD/MyST-NB-1.1.0/tests/conftest.py:286: AssertionError
----------------------------- Captured stderr call -----------------------------
[IPKernelApp] WARNING | debugpy_stream undefined, debugging will not be enabled
=============================== warnings summary ===============================
../../../../usr/lib/python3.12/site-packages/jupyter_client/connect.py:22
  /usr/lib/python3.12/site-packages/jupyter_client/connect.py:22: DeprecationWarning: Jupyter is migrating its paths to use standard platformdirs
  given by the platformdirs library.  To remove this warning and
  see the appropriate new directories, set the environment variable
  `JUPYTER_PLATFORM_DIRS=1` and then run `jupyter --paths`.
  The use of platformdirs will be the default in `jupyter_core` v6
    from jupyter_core.paths import jupyter_data_dir, jupyter_runtime_dir, secure_write
tests/test_cli.py: 5 warnings
tests/test_codecell_file.py: 4 warnings
tests/test_docutils.py: 28 warnings
tests/test_eval.py: 2 warnings
tests/test_execute.py: 52 warnings
tests/test_glue.py: 2 warnings
tests/test_parser.py: 10 warnings
tests/test_render_outputs.py: 24 warnings
tests/test_text_based.py: 5 warnings
  /usr/lib/python3.12/site-packages/myst_parser/mdit_to_docutils/base.py:66: DeprecationWarning: The frontend.OptionParser class will be replaced by a subclass of argparse.ArgumentParser in Docutils 0.21 or later.
    settings = OptionParser(components=(parser_cls,)).get_default_values()
tests/test_cli.py: 345 warnings
tests/test_codecell_file.py: 276 warnings
tests/test_docutils.py: 1932 warnings
tests/test_eval.py: 138 warnings
tests/test_execute.py: 3588 warnings
tests/test_glue.py: 138 warnings
tests/test_parser.py: 690 warnings
tests/test_render_outputs.py: 1656 warnings
tests/test_text_based.py: 345 warnings
  /usr/lib64/python3.12/optparse.py:1000: DeprecationWarning: The frontend.Option class will be removed in Docutils 0.21 or later.
    option = self.option_class(*args, **kwargs)
tests/test_codecell_file.py: 3 warnings
tests/test_execute.py: 23 warnings
tests/test_text_based.py: 3 warnings
  /usr/lib64/python3.12/site-packages/sqlalchemy/sql/schema.py:3585: DeprecationWarning: datetime.datetime.utcnow() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.now(datetime.UTC).
    return util.wrap_callable(lambda ctx: fn(), fn)  # type: ignore
tests/test_execute.py::test_rebuild_cache
  /usr/lib/python3.12/site-packages/jupyter_cache/cache/db.py:371: DeprecationWarning: datetime.datetime.utcnow() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.now(datetime.UTC).
    record.accessed = datetime.utcnow()
-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
=========================== short test summary info ============================
FAILED tests/test_execute.py::test_complex_outputs_unrun_cache - AssertionErr...
FAILED tests/test_execute.py::test_complex_outputs_unrun_auto - AssertionErro...
FAILED tests/test_execute.py::test_custom_convert_auto - AssertionError: FILE...
FAILED tests/test_execute.py::test_custom_convert_cache - AssertionError: FIL...
================= 4 failed, 76 passed, 9271 warnings in 47.99s =================



Nothing will be approved until upstream clarify the license situation.


Package Review
==============

Legend:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
[ ] = Manual review needed



===== MUST items =====

Generic:
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[?]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "BSD 3-Clause License", "*No copyright*
     MIT License". 166 files have unknown license. Detailed output of
     licensecheck in /home/bob/packaging/review/python-myst-nb/review-
     python-myst-nb/licensecheck.txt
[?]: If the package is under multiple licenses, the licensing breakdown
     must be documented in the spec.
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: Package contains desktop file if it is a GUI application.
[-]: Development files must be in a -devel package
[x]: Package uses nothing in %doc for runtime.
[x]: Package consistently uses macros (instead of hard-coded directory
     names).
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
[x]: Package obeys FHS, except libexecdir and /usr/target.
[-]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[x]: Requires correct, justified where necessary.
[x]: Spec file is legible and written in American English.
[-]: Package contains systemd file(s) if in need.
[x]: Package is not known to require an ExcludeArch tag.
[-]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 34783 bytes in 2 files.
[x]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[x]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: If (and only if) the source package includes the text of the
     license(s) in its own file, then that file, containing the text of the
     license(s) for the package is included in %license.
[x]: The License field must be a valid SPDX expression.
[x]: Package requires other packages for directories it uses.
[x]: Package does not own files or directories owned by other packages.
[x]: Package uses either %{buildroot} or $RPM_BUILD_ROOT
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Dist tag is present.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package does not use a name that already exists.
[x]: Package is not relocatable.
[x]: Sources used to build the package match the upstream source, as
     provided in the spec URL.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[x]: File names are valid UTF-8.
[x]: Packages must not store files under /srv, /opt or /usr/local

Python:
[x]: Binary eggs must be removed in %prep
     Note: Cannot find any build in BUILD directory (--prebuilt option?)
[x]: Python eggs must not download any dependencies during the build
     process.
[x]: A package which is used by another package via an egg interface should
     provide egg info.
[x]: Package meets the Packaging Guidelines::Python
[x]: Package contains BR: python2-devel or python3-devel
[x]: Packages MUST NOT have dependencies (either build-time or runtime) on
     packages named with the unversioned python- prefix unless no properly
     versioned package exists. Dependencies on Python packages instead MUST
     use names beginning with python2- or python3- as appropriate.
[x]: Python packages must not contain %{pythonX_site(lib|arch)}/* in %files

===== SHOULD items =====

Generic:
[-]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.
[x]: Final provides and requires are sane (see attachments).
[?]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[?]: Package should compile and build into binary rpms on all supported
     architectures.
[!]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[x]: Reviewer should test that the package builds in mock.
[x]: Buildroot is not present
[x]: Package has no %clean section with rm -rf %{buildroot} (or
     $RPM_BUILD_ROOT)
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Sources can be downloaded from URI in Source: tag
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

===== EXTRA items =====

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python3-myst-nb-1.1.0-1.fc41.noarch.rpm
          python-myst-nb-1.1.0-1.fc41.src.rpm
============================================================================================================== rpmlint session starts ==============================================================================================================
rpmlint: 2.5.0
configuration:
    /usr/lib/python3.12/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
rpmlintrc: [PosixPath('/tmp/tmpla7g628h')]
checks: 32, packages: 2

python-myst-nb.src: E: spelling-error ('Jupyter', 'Summary(en_US) Jupyter -> Jupiter, Junketeer')
python3-myst-nb.noarch: E: spelling-error ('Jupyter', 'Summary(en_US) Jupyter -> Jupiter, Junketeer')
======================================================================== 2 packages and 0 specfiles checked; 2 errors, 0 warnings, 18 filtered, 2 badness; has taken 0.7 s =========================================================================

Comment 3 Jerry James 2024-06-21 03:43:45 UTC
(In reply to Robert-André Mauchin 🐧 from comment #2)
> - License is unclear, I opened a bug report:
> https://github.com/executablebooks/MyST-NB/issues/602

Upstream says that MIT is incorrect, so I have changed the license to be BSD-3-Clause only.

>  - Use pytest for tests are %tox is not running them"

Good catch, thank you.

> Some will fail. Most likely due too matplotlib being newer than the one
> expected upstream.

It's actually a newer version of sphinx that seems to be the issue.  Four tests are affected.  Those tests simply want to verify that the output contains a <script>...</script> tag containing "application/vnd.jupyter.widget-view+json".  The png filenames are not under test.  Therefore, I have added a sed expression in %prep to change the filenames to those actually generated by sphinx in Rawhide.  This lets us keep testing that the expected <script> tag is generated.

Upstream is aware that there are sphinx issues, and promised a new release in 1 week to fix them.  That was 3 weeks ago. :-)  See https://github.com/executablebooks/MyST-NB/pull/599.

I uploaded a new version to the same URLs as before.

Comment 4 Jerry James 2024-06-27 19:04:29 UTC
Version 1.1.1 is out and resolves the license issue.  A conversation with upstream reveals that a newer version of matplotlib is to blame for the test failures after all.  The testing section of pyproject.toml says:

    # Matplotlib outputs are sensitive to the matplotlib version
    "matplotlib==3.7.*",

and we have matplotlib 3.9.0 in Rawhide, so the test problem is self-inflicted.  In this case, the difference in output is only the names of a few png files.  The tests in question aren't testing that, so I have added a sed invocation to %prep to change the names to those produced by matplotlib 3.9.0.  That way, the tests can still be run and fulfill their intended purposes.  New URLs:

Spec URL: https://jjames.fedorapeople.org/python-myst-nb/python-myst-nb.spec
SRPM URL: https://jjames.fedorapeople.org/python-myst-nb/python-myst-nb-1.1.1-1.fc41.src.rpm

Comment 5 Fedora Review Service 2024-06-27 19:13:53 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/7678079
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2278424-python-myst-nb/fedora-rawhide-x86_64/07678079-python-myst-nb/fedora-review/review.txt

Please take a look if any issues were found.


---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 6 Jerry James 2024-06-29 03:16:25 UTC
@zebob.m do I remember correctly that you like to have the needinfo flag set when a packager responds?

Comment 7 Jerry James 2024-07-12 20:57:05 UTC
@zebob.m are you able to continue with this review?

Comment 8 Jerry James 2024-07-13 18:07:34 UTC
It has been well over a month since the last comment by the reviewer.  I am invoking the "Reviewer Not Responding" policy: https://docs.fedoraproject.org/en-US/fesco/Package_review_policy/#reviewer_not_responding

@zebob.m, please respond in the next week indicating whether you intend to continue the review or not.

Comment 9 Jerry James 2024-07-20 19:30:55 UTC
In accordance with the "Reviewer Not Responding" policy, I am making this review available for other reviewers.  Bob, I hope you are well.

Comment 10 Zbigniew Jędrzejewski-Szmek 2024-07-21 16:28:59 UTC
%_description is strangely formatted… There are double spaces between
sentences and the line breaks seem uneven.

> %{?with_doc:-x rtd}%{?with_test:-x testing}
I think this will not be valid if both are enabled, since there is
no space between the two expressions.

Hmm, I'm not sure if the package name should use 'python3-' prefix.
Is the primary purpose of the package the importable module or the
tools? Because if the latter, maybe the binary package should called
'myst-nb' or 'mystnb'?
Or even if not, maybe some Provides should be added?

Comment 11 Jerry James 2024-07-21 22:05:47 UTC
(In reply to Zbigniew Jędrzejewski-Szmek from comment #10)
> %_description is strangely formatted… There are double spaces between
> sentences and the line breaks seem uneven.

I learned to type on a manual typewriter, where the teacher beat into our heads that there must be two spaces following a period that ends a sentence, and one space following a period that ends an abbreviation.  This was reinforced in grad school; the TeX typesetting system follows the same convention.  It is further reinforced by my long-standing use of Emacs to edit files.  Its line wrapping algorithm is affected by the number of spaces after a period.

Anyway, I don't consider that strange at all.  The %description section of all 400-some packages I maintain follow this convention, even if it is archaic.

The uneven line breaks are due to wrapping at 72 characters.  I used to wrap at 78, but somebody complained that that made a package description look weird in some GUI interface.  I don't even remember what GUI interface it was, but I've been wrapping at 72 ever since, out of habit I guess.  I see that rpmlint considers a description line too long it if is over 79 characters.  I have rewrapped %description at 79 characters.  See if that looks better to you.

> > %{?with_doc:-x rtd}%{?with_test:-x testing}
> I think this will not be valid if both are enabled, since there is
> no space between the two expressions.

Yes, you're right.  Nor am I sure that %pyproject_buildrequires can be given two -x arguments.  I have introduced an %if to ensure correct syntax is used.

> Hmm, I'm not sure if the package name should use 'python3-' prefix.
> Is the primary purpose of the package the importable module or the
> tools? Because if the latter, maybe the binary package should called
> 'myst-nb' or 'mystnb'?
> Or even if not, maybe some Provides should be added?

That's a good point.  I believe the primary purpose is to provide the tools.  I have changed the package name to myst-nb and added python3 provides.  New URLs:

Spec URL: https://jjames.fedorapeople.org/myst-nb/myst-nb.spec
SRPM URL: https://jjames.fedorapeople.org/myst-nb/myst-nb-1.1.1-1.fc41.src.rpm

Comment 12 Zbigniew Jędrzejewski-Szmek 2024-07-22 09:14:33 UTC
> I have rewrapped %description at 79 characters.  See if that looks better to you.
Yes, thank you.

> > %{?with_doc:-x rtd}%{?with_test:-x testing}

Maybe like this:
features=(
  %{?with_test:"testing"}
  %{?with_doc:"rtd"}
)
features=$(IFS=,; echo "${features[*]}")
%pyproject_buildrequires ${features:+-x ${features}}

It's longer, but I think it's more readable. It also scales to more than two "features".
(I know this doesn't matter :))

+ package names is OK
+ builds and installs OK
+ license is acceptable for Fedora (BSD-3-Clause)
+ license is specified correctly (with spdx)
+ builds and installs OK
+ BR/P/R look correct
+ %check is present and passes

Package is APPROVED.

One more suggestion: add '-v' to %pytest so that individual test names are
printed.

Comment 13 Jerry James 2024-07-22 15:48:56 UTC
(In reply to Zbigniew Jędrzejewski-Szmek from comment #12)
> Maybe like this:
> features=(
>   %{?with_test:"testing"}
>   %{?with_doc:"rtd"}
> )
> features=$(IFS=,; echo "${features[*]}")
> %pyproject_buildrequires ${features:+-x ${features}}
> 
> It's longer, but I think it's more readable. It also scales to more than two
> "features".
> (I know this doesn't matter :))

That's certainly clever.  I'm not sure it's more readable, though.  I guess it depends on who is doing the reading. :-)  I'll think about this before I import the package.

> One more suggestion: add '-v' to %pytest so that individual test names are
> printed.

Yes, good idea.  Thank you for the quick review!

Comment 14 Jerry James 2024-07-22 20:48:37 UTC
I wondered if I could do any better with lua and came up with this, which is even longer than your shell version:

%generate_buildrequires
%global features %{lua:
  local f = {}
  if rpm.expand("%{?with_doc}") == "1" then table.insert(f, "rtd") end
  if rpm.expand("%{?with_test}") == "1" then table.insert(f, "testing") end
  if next(f) ~= nil then print("-x ", table.concat(f, ",")) end
}
%pyproject_buildrequires %features

Then I wondered if I could make that more general and came up with this even longer version:

%generate_buildrequires
%define features(-) %{lua:
  local myarg = {}
  for _, v in pairs(arg) do
    for s, t in string.gmatch(v, "(%w+):(%w+)") do
      if rpm.expand("%{?with_" .. s .. "}") == "1" then
        table.insert(myarg, t)
      end
    end
  end
  if next(myarg) ~= nil then print("-x ", table.concat(myarg, ",")) end
}
%pyproject_buildrequires %{features test:testing doc:rtd}

That second version does NOT work if %global is used instead of %define.  I'm not sure why.

Anyway, all of these attempts at being general are cute, but ultimately less readable than what I already had in the spec file, I think.  It's unlikely that the doc bcond will ever be set to true, so I should probably just rip that out of the spec file altogether.  I'm going to import the version you approved for now, with the addition of the -v argument to %pytest.

Comment 15 Fedora Admin user for bugzilla script actions 2024-07-22 20:52:40 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/myst-nb

Comment 16 Fedora Update System 2024-07-22 21:23:04 UTC
FEDORA-2024-96e39e8a1a (myst-nb-1.1.1-1.fc40) has been submitted as an update to Fedora 40.
https://bodhi.fedoraproject.org/updates/FEDORA-2024-96e39e8a1a

Comment 17 Fedora Update System 2024-07-23 02:01:53 UTC
FEDORA-2024-96e39e8a1a has been pushed to the Fedora 40 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --refresh --advisory=FEDORA-2024-96e39e8a1a \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2024-96e39e8a1a

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 18 Fedora Update System 2024-07-31 02:45:21 UTC
FEDORA-2024-96e39e8a1a (myst-nb-1.1.1-1.fc40) has been pushed to the Fedora 40 stable repository.
If problem still persists, please make note of it in this bug report.


Note You need to log in before you can comment on or make changes to this bug.