refactor: migrate to `pyproject.toml` by Borda · Pull Request #1267 · sphinx-gallery/sphinx-gallery

Borda · 2024-03-10T14:07:15Z

for more information, see https://pre-commit.ci

setup.py

for more information, see https://pre-commit.ci

Borda · 2024-03-11T18:24:09Z

@larsoner mind have a look 🐿️

larsoner

Looks reasonable in principle aside from some potential differences I suspect are there. Those differences make me think that it would be safest to do a directory diff between the unzipped sdist and/or .whl on master and this PR to make sure we aren't adding or removing things we shouldn't.

pyproject.toml

MANIFEST.in

pyproject.toml

for more information, see https://pre-commit.ci

MANIFEST.in

larsoner · 2024-03-12T15:04:42Z

Can you try the directory diff and let me know how it looks?

Borda · 2024-03-14T16:46:41Z

Can you try the directory diff and let me know how it looks?

not sure what you mean, like building a package from master and, with this suggestion to see if there is a difference in the package? 🐿️

larsoner · 2024-03-14T17:23:32Z

Yes for the sdist and for the .whl

Borda · 2024-03-19T18:32:05Z

this is the version from master:

dist/master/
└── sphinx-gallery-0.16.dev0
    ├── CHANGES.rst
    ├── examples
    │   ├── local_module.py
    │   ├── no_output
    │   │   ├── just_code.py
    │   │   ├── plot_raise.py
    │   │   ├── plot_strings.py
    │   │   ├── plot_syntaxerror.py
    │   │   └── README.txt
    │   ├── plot_0_sin.py
    │   ├── plot_1_exp.py
    │   ├── plot_2_seaborn.py
    │   ├── plot_3_capture_repr.py
    │   ├── plot_4b_provide_thumbnail.py
    │   ├── plot_4_choose_thumbnail.py
    │   ├── plot_5_unicode_everywhere.py
    │   ├── plot_6_function_identifier.py
    │   ├── plot_7_sys_argv.py
    │   ├── plot_8_animations.py
    │   └── README.txt
    ├── ignore_words.txt
    ├── LICENSE
    ├── MANIFEST.in
    ├── PKG-INFO
    ├── plotly_examples
    │   ├── plot_0_plotly.py
    │   └── README.rst
    ├── pyproject.toml
    ├── pyvista_examples
    │   ├── plot_collisions.py
    │   ├── plot_glyphs.py
    │   ├── plot_lighting.py
    │   ├── plot_ray_trace.py
    │   └── README.rst
    ├── README.rst
    ├── requirements.txt
    ├── setup.cfg
    ├── setup.py
    ├── sphinx_gallery
    │   ├── backreferences.py
    │   ├── block_parser.py
    │   ├── directives.py
    │   ├── docs_resolv.py
    │   ├── downloads.py
    │   ├── gen_gallery.py
    │   ├── gen_rst.py
    │   ├── __init__.py
    │   ├── interactive_example.py
    │   ├── load_style.py
    │   ├── notebook.py
    │   ├── py_source_parser.py
    │   ├── recommender.py
    │   ├── scrapers.py
    │   ├── sorting.py
    │   ├── _static
    │   │   ├── binder_badge_logo.svg
    │   │   ├── broken_example.png
    │   │   ├── jupyterlite_badge_logo.svg
    │   │   ├── no_image.png
    │   │   ├── sg_gallery-binder.css
    │   │   ├── sg_gallery.css
    │   │   ├── sg_gallery-dataframe.css
    │   │   └── sg_gallery-rendered-html.css
    │   ├── tests
    │   │   ├── conftest.py
    │   │   ├── __init__.py
    │   │   ├── reference_parse.txt
    │   │   ├── test_backreferences.py
    │   │   ├── test_block_parser.py
    │   │   ├── testconfs
    │   │   │   ├── index.rst
    │   │   │   └── src
    │   │   │       ├── plot_1.py
    │   │   │       ├── plot_2.py
    │   │   │       ├── plot_3.py
    │   │   │       └── README.txt
    │   │   ├── test_docs_resolv.py
    │   │   ├── test_full_noexec.py
    │   │   ├── test_full.py
    │   │   ├── test_gen_gallery.py
    │   │   ├── test_gen_rst.py
    │   │   ├── test_interactive_example.py
    │   │   ├── test_load_style.py
    │   │   ├── test_notebook.py
    │   │   ├── test_py_source_parser.py
    │   │   ├── test_recommender.py
    │   │   ├── test_scrapers.py
    │   │   ├── test_sorting.py
    │   │   └── tinybuild
    │   │       ├── doc
    │   │       │   ├── binder
    │   │       │   │   └── requirements.txt
    │   │       │   ├── conf.py
    │   │       │   ├── index.rst
    │   │       │   ├── make.bat
    │   │       │   ├── Makefile
    │   │       │   ├── minigallery.rst
    │   │       │   ├── _static_nonstandard
    │   │       │   │   └── demo.png
    │   │       │   └── _templates
    │   │       │       └── module.rst
    │   │       ├── examples
    │   │       │   ├── future
    │   │       │   │   ├── plot_future_imports_broken.py
    │   │       │   │   ├── plot_future_imports.py
    │   │       │   │   └── README.rst
    │   │       │   ├── __init__.py
    │   │       │   ├── isentropic.m
    │   │       │   ├── julia_sample.jl
    │   │       │   ├── local_module.py
    │   │       │   ├── parse_this.cpp
    │   │       │   ├── plot_animation.py
    │   │       │   ├── plot_command_line_args.py
    │   │       │   ├── plot_defer_figures.py
    │   │       │   ├── plot_log.py
    │   │       │   ├── plot_matplotlib_alt.py
    │   │       │   ├── plot_matplotlib_backend.py
    │   │       │   ├── plot_numpy_matplotlib.py
    │   │       │   ├── plot_pickle.py
    │   │       │   ├── plot_repr.py
    │   │       │   ├── plot_scraper_broken.py
    │   │       │   ├── plot_second_future_imports.py
    │   │       │   ├── plot_svg.py
    │   │       │   ├── plot_webp.py
    │   │       │   └── README.txt
    │   │       ├── examples_rst_index
    │   │       │   ├── examp_subdir1
    │   │       │   │   ├── plot_sub1.py
    │   │       │   │   └── README.txt
    │   │       │   ├── examp_subdir2
    │   │       │   │   ├── index.rst
    │   │       │   │   └── plot_sub2.py
    │   │       │   ├── index.rst
    │   │       │   └── plot_examp.py
    │   │       └── examples_with_rst
    │   │           ├── plot_boo.py
    │   │           ├── plot_cos.py
    │   │           ├── README.txt
    │   │           ├── rst_example1.rst
    │   │           └── rst_example2.rst
    │   └── utils.py
    ├── sphinx_gallery.egg-info
    │   ├── dependency_links.txt
    │   ├── entry_points.txt
    │   ├── PKG-INFO
    │   ├── requires.txt
    │   ├── SOURCES.txt
    │   └── top_level.txt
    └── tutorials
        ├── plot_parse.py
        └── README.txt

and this is with this PR:

dist/pr-pyproject/
└── sphinx-gallery-0.16.dev0
    ├── CHANGES.rst
    ├── examples
    │   ├── local_module.py
    │   ├── no_output
    │   │   ├── just_code.py
    │   │   ├── plot_raise.py
    │   │   ├── plot_strings.py
    │   │   ├── plot_syntaxerror.py
    │   │   └── README.txt
    │   ├── plot_0_sin.py
    │   ├── plot_1_exp.py
    │   ├── plot_2_seaborn.py
    │   ├── plot_3_capture_repr.py
    │   ├── plot_4b_provide_thumbnail.py
    │   ├── plot_4_choose_thumbnail.py
    │   ├── plot_5_unicode_everywhere.py
    │   ├── plot_6_function_identifier.py
    │   ├── plot_7_sys_argv.py
    │   ├── plot_8_animations.py
    │   └── README.txt
    ├── ignore_words.txt
    ├── LICENSE
    ├── MANIFEST.in
    ├── PKG-INFO
    ├── plotly_examples
    │   ├── plot_0_plotly.py
    │   └── README.rst
    ├── pyproject.toml
    ├── pyvista_examples
    │   ├── plot_collisions.py
    │   ├── plot_glyphs.py
    │   ├── plot_lighting.py
    │   ├── plot_ray_trace.py
    │   └── README.rst
    ├── README.rst
    ├── setup.cfg
    ├── sphinx_gallery
    │   ├── backreferences.py
    │   ├── block_parser.py
    │   ├── directives.py
    │   ├── docs_resolv.py
    │   ├── downloads.py
    │   ├── gen_gallery.py
    │   ├── gen_rst.py
    │   ├── __init__.py
    │   ├── interactive_example.py
    │   ├── load_style.py
    │   ├── notebook.py
    │   ├── py_source_parser.py
    │   ├── recommender.py
    │   ├── scrapers.py
    │   ├── sorting.py
    │   ├── _static
    │   │   ├── binder_badge_logo.svg
    │   │   ├── broken_example.png
    │   │   ├── jupyterlite_badge_logo.svg
    │   │   ├── no_image.png
    │   │   ├── sg_gallery-binder.css
    │   │   ├── sg_gallery.css
    │   │   ├── sg_gallery-dataframe.css
    │   │   └── sg_gallery-rendered-html.css
    │   ├── tests
    │   │   ├── conftest.py
    │   │   ├── __init__.py
    │   │   ├── reference_parse.txt
    │   │   ├── test_backreferences.py
    │   │   ├── test_block_parser.py
    │   │   ├── testconfs
    │   │   │   ├── index.rst
    │   │   │   └── src
    │   │   │       ├── plot_1.py
    │   │   │       ├── plot_2.py
    │   │   │       ├── plot_3.py
    │   │   │       └── README.txt
    │   │   ├── test_docs_resolv.py
    │   │   ├── test_full_noexec.py
    │   │   ├── test_full.py
    │   │   ├── test_gen_gallery.py
    │   │   ├── test_gen_rst.py
    │   │   ├── test_interactive_example.py
    │   │   ├── test_load_style.py
    │   │   ├── test_notebook.py
    │   │   ├── test_py_source_parser.py
    │   │   ├── test_recommender.py
    │   │   ├── test_scrapers.py
    │   │   ├── test_sorting.py
    │   │   └── tinybuild
    │   │       ├── doc
    │   │       │   ├── binder
    │   │       │   │   └── requirements.txt
    │   │       │   ├── conf.py
    │   │       │   ├── index.rst
    │   │       │   ├── make.bat
    │   │       │   ├── Makefile
    │   │       │   ├── minigallery.rst
    │   │       │   ├── _static_nonstandard
    │   │       │   │   └── demo.png
    │   │       │   └── _templates
    │   │       │       └── module.rst
    │   │       ├── examples
    │   │       │   ├── future
    │   │       │   │   ├── plot_future_imports_broken.py
    │   │       │   │   ├── plot_future_imports.py
    │   │       │   │   └── README.rst
    │   │       │   ├── __init__.py
    │   │       │   ├── isentropic.m
    │   │       │   ├── julia_sample.jl
    │   │       │   ├── local_module.py
    │   │       │   ├── parse_this.cpp
    │   │       │   ├── plot_animation.py
    │   │       │   ├── plot_command_line_args.py
    │   │       │   ├── plot_defer_figures.py
    │   │       │   ├── plot_log.py
    │   │       │   ├── plot_matplotlib_alt.py
    │   │       │   ├── plot_matplotlib_backend.py
    │   │       │   ├── plot_numpy_matplotlib.py
    │   │       │   ├── plot_pickle.py
    │   │       │   ├── plot_repr.py
    │   │       │   ├── plot_scraper_broken.py
    │   │       │   ├── plot_second_future_imports.py
    │   │       │   ├── plot_svg.py
    │   │       │   ├── plot_webp.py
    │   │       │   └── README.txt
    │   │       ├── examples_rst_index
    │   │       │   ├── examp_subdir1
    │   │       │   │   ├── plot_sub1.py
    │   │       │   │   └── README.txt
    │   │       │   ├── examp_subdir2
    │   │       │   │   ├── index.rst
    │   │       │   │   └── plot_sub2.py
    │   │       │   ├── index.rst
    │   │       │   └── plot_examp.py
    │   │       └── examples_with_rst
    │   │           ├── plot_boo.py
    │   │           ├── plot_cos.py
    │   │           ├── README.txt
    │   │           ├── rst_example1.rst
    │   │           └── rst_example2.rst
    │   └── utils.py
    ├── sphinx_gallery.egg-info
    │   ├── dependency_links.txt
    │   ├── entry_points.txt
    │   ├── PKG-INFO
    │   ├── requires.txt
    │   ├── SOURCES.txt
    │   └── top_level.txt
    └── tutorials
        ├── plot_parse.py
        └── README.txt

the only diff is as expected missing:

    ├── requirements.txt
    ...
    ├── setup.py

larsoner · 2024-03-19T18:43:45Z

Thanks @Borda !

lucyleeow · 2024-03-19T22:09:04Z

Thank you @Borda 🙏 !

Borda and others added 6 commits March 10, 2024 15:06

lint: pyproject

6a43009

[pre-commit.ci] auto fixes from pre-commit.com hooks

88774a2

for more information, see https://pre-commit.ci

migrate

acef99b

manifest

591bfe5

setuptools

f6a052e

setuptools-scm

99beb06

Borda commented Mar 10, 2024

View reviewed changes

setup.py Outdated Show resolved Hide resolved

This was referenced Mar 10, 2024

allow call script as pkg entry #1268

Merged

pyproject: cleaning pytest config #1269

Merged

larsoner added the maintenance label Mar 11, 2024

Borda and others added 4 commits March 11, 2024 18:51

Merge branch 'master' into refactor/pyproject

d6c527a

[project.scripts] sphinx_gallery_py2jupyter

d9b725c

[pre-commit.ci] auto fixes from pre-commit.com hooks

bcbdcc3

for more information, see https://pre-commit.ci

check-manifest

cbc5e2a

Borda marked this pull request as ready for review March 11, 2024 18:09

larsoner reviewed Mar 11, 2024

View reviewed changes

pyproject.toml Show resolved Hide resolved

pyproject.toml Outdated Show resolved Hide resolved

MANIFEST.in Outdated Show resolved Hide resolved

Borda commented Mar 11, 2024

View reviewed changes

pyproject.toml Show resolved Hide resolved

Borda and others added 3 commits March 11, 2024 23:18

Apply suggestions from code review

1b69dce

[pre-commit.ci] auto fixes from pre-commit.com hooks

06cfcbf

for more information, see https://pre-commit.ci

Update manifest

088def3

larsoner reviewed Mar 12, 2024

View reviewed changes

MANIFEST.in Outdated Show resolved Hide resolved

Update MANIFEST.in

7264cb3

Merge branch 'master' into refactor/pyproject

6f01dce

Borda requested review from larsoner and lucyleeow March 19, 2024 18:32

larsoner merged commit 92ed86e into sphinx-gallery:master Mar 19, 2024

Borda deleted the refactor/pyproject branch March 19, 2024 19:02

AlexSzatmary mentioned this pull request Jun 2, 2024

Include dev dependencies in pyproject.toml and update docs on requirements #1317

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: migrate to `pyproject.toml`#1267

refactor: migrate to `pyproject.toml`#1267
larsoner merged 15 commits intosphinx-gallery:masterfrom
Borda:refactor/pyproject

Borda commented Mar 10, 2024

Uh oh!

Uh oh!

Borda commented Mar 11, 2024

Uh oh!

larsoner left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

larsoner commented Mar 12, 2024

Uh oh!

Borda commented Mar 14, 2024 •

edited

Loading

Uh oh!

larsoner commented Mar 14, 2024

Uh oh!

Borda commented Mar 19, 2024 •

edited

Loading

Uh oh!

larsoner commented Mar 19, 2024

Uh oh!

lucyleeow commented Mar 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Borda commented Mar 10, 2024

Uh oh!

Uh oh!

Borda commented Mar 11, 2024

Uh oh!

larsoner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

larsoner commented Mar 12, 2024

Uh oh!

Borda commented Mar 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

larsoner commented Mar 14, 2024

Uh oh!

Borda commented Mar 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

larsoner commented Mar 19, 2024

Uh oh!

lucyleeow commented Mar 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Borda commented Mar 14, 2024 •

edited

Loading

Borda commented Mar 19, 2024 •

edited

Loading