move build configuration into `pyproject.toml` #6847

zacharyburnett · 2022-05-16T18:22:06Z

Note
#7912 should be merged before this PR to test the build with cibuildwheel

Description

setuptools now supports the [project] table, which is defined by PEP621.

Additionally, setuptools now supports its own entry in pyproject.toml called [tool.setuptools] (pypa/setuptools#1688, https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html#setuptools-specific-configuration); however, it comes with the following disclaimer:

Support for declaring configurations not standardized by PEP 621 (i.e. the [tool.setuptools] table), is still in beta stage and might change in future releases.

Reading toml is supported natively in Python 3.11 with tomllib

Given this, we can attempt to consolidate the build configuration into a single pyproject.toml file that can possibly be read by other build systems in the future.

Checklist

Tests
[N/A] ~~Documentation~~
Change log
[N/A] ~~Milestone~~
Label(s)

docs/conf.py

tox.ini

codecov · 2022-05-19T15:32:08Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (3cf897a) 75.42% compared to head (bd80933) 75.42%.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #6847   +/-   ##
=======================================
  Coverage   75.42%   75.42%           
=======================================
  Files         464      464           
  Lines       37938    37936    -2     
=======================================
  Hits        28615    28615           
+ Misses       9323     9321    -2

Flag	Coverage Δ		*Carryforward flag
nightly	`77.37% <ø> (+<0.01%)`	⬆️	Carriedforward from 9a73e53

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

zacharyburnett · 2022-05-19T17:42:33Z

there's an issue with the package data so I will convert this back to draft for now

zacharyburnett · 2023-11-17T13:11:08Z

we can test the effect of this PR on the build after #7912 is merged

zacharyburnett · 2023-12-06T19:29:00Z

it looks like the tests all pass here (except for the lint check which should be resolved by #8111 / #8112), so I think this is ready to merge

add note for tox testing issues

CHANGES.rst

pyproject.toml

docs/conf.py

hbushouse

Looks OK to me, I guess (but what do I know about build configuration?). I assume all the CI failures with devdeps are expected, because of numpy?

zacharyburnett · 2023-12-07T16:42:31Z

great! I'll merge this then, thanks!

mcara · 2023-12-07T16:49:34Z

tox.ini

@@ -68,6 +68,7 @@ deps =
    xdist: pytest-xdist
    oldestdeps: minimum_dependencies
 package =
+    # necessary so the C extensions are available for import; see https://github.com/spacetelescope/jwst/issues/7386#issuecomment-1344371482


I do not think this is necessary. This can be avoided my a artful (as opposite to scientific, deterministic) use of various tox directory names. That is, the path to where the commands must be run, the location of the configuration files, etc. can be adjusted in such a way that this may not be needed. See https://github.com/spacetelescope/stsci.imagestats on how this was done there.

One possible complication might be on RTD or pytest of docstrings if there are examples that use/import C code.

zacharyburnett changed the title ~~Consolidate build config into pyproject.toml using poetry-core~~ Consolidate build config into pyproject.toml May 18, 2022

zacharyburnett self-assigned this May 18, 2022

zacharyburnett force-pushed the consolidate_build_config branch 2 times, most recently from 5483667 to 1b99f2d Compare May 18, 2022 15:27

zacharyburnett marked this pull request as ready for review May 18, 2022 15:31

zacharyburnett marked this pull request as draft May 18, 2022 15:31

zacharyburnett force-pushed the consolidate_build_config branch from 1b99f2d to 7a31d53 Compare May 18, 2022 15:37

zacharyburnett commented May 18, 2022

View reviewed changes

docs/conf.py Outdated Show resolved Hide resolved

zacharyburnett commented May 18, 2022

View reviewed changes

docs/conf.py Outdated Show resolved Hide resolved

zacharyburnett force-pushed the consolidate_build_config branch from 7a31d53 to b3a786c Compare May 18, 2022 15:46

zacharyburnett commented May 18, 2022

View reviewed changes

tox.ini Outdated Show resolved Hide resolved

zacharyburnett force-pushed the consolidate_build_config branch from b3a786c to b99844c Compare May 18, 2022 15:49

zacharyburnett marked this pull request as ready for review May 19, 2022 15:33

zacharyburnett requested review from hbushouse, stscieisenhamer and nden and removed request for stscieisenhamer and hbushouse May 19, 2022 15:34

zacharyburnett marked this pull request as draft May 19, 2022 17:42

zacharyburnett force-pushed the consolidate_build_config branch 2 times, most recently from b0fb38e to 6dd7e61 Compare May 23, 2022 14:29

zacharyburnett mentioned this pull request May 23, 2022

move build configuration into pyproject.toml spacetelescope/stcal#95

Merged

zacharyburnett force-pushed the consolidate_build_config branch from 62309de to ebb3dd7 Compare May 23, 2022 20:34

zacharyburnett force-pushed the consolidate_build_config branch from 7b46d88 to a021a70 Compare May 31, 2022 16:14

zacharyburnett mentioned this pull request Jun 2, 2022

move build configuration into pyproject.toml spacetelescope/romancal#512

Merged

5 tasks

zacharyburnett force-pushed the consolidate_build_config branch 2 times, most recently from 9d33653 to 0d64e30 Compare June 7, 2022 13:10

zacharyburnett changed the title ~~Consolidate build config into pyproject.toml~~ move build config into pyproject.toml Jun 7, 2022

zacharyburnett force-pushed the consolidate_build_config branch 2 times, most recently from fef8992 to 6aca0c5 Compare June 12, 2023 15:39

zacharyburnett force-pushed the consolidate_build_config branch from e17881d to a692a13 Compare July 24, 2023 11:33

zacharyburnett force-pushed the consolidate_build_config branch from 58cb8ab to 87edcbd Compare August 17, 2023 13:42

zacharyburnett force-pushed the consolidate_build_config branch from 87edcbd to a7c04d0 Compare November 17, 2023 13:03

zacharyburnett force-pushed the consolidate_build_config branch from a7c04d0 to cd3f2e7 Compare December 1, 2023 16:55

zacharyburnett mentioned this pull request Dec 5, 2023

use PyPI upload workflow from OpenAstronomy #7912

Merged

7 tasks

zacharyburnett force-pushed the consolidate_build_config branch from 8c7a58a to a0e7841 Compare December 5, 2023 15:01

zacharyburnett marked this pull request as draft December 5, 2023 15:07

zacharyburnett force-pushed the consolidate_build_config branch 2 times, most recently from 95645bc to 3cd395f Compare December 6, 2023 18:21

zacharyburnett added the run devdeps tests label Dec 6, 2023

zacharyburnett marked this pull request as ready for review December 6, 2023 19:24

zacharyburnett added 4 commits December 7, 2023 09:57

move build configuration from setup.cfg to pyproject.toml

a322ce5

add note for tox testing issues

bump stdatamodels to 1.8.4

c2e3d03

fix dependencies

6db8f2e

remove upper pin on Python version

9a73e53

zacharyburnett force-pushed the consolidate_build_config branch from 3cd395f to 9a73e53 Compare December 7, 2023 14:57

hbushouse reviewed Dec 7, 2023

View reviewed changes

CHANGES.rst Outdated Show resolved Hide resolved

pyproject.toml Show resolved Hide resolved

zacharyburnett added 2 commits December 7, 2023 10:43

remove setup.cfg

1beeeb6

fix change log entry

3fa5f17

zacharyburnett commented Dec 7, 2023

View reviewed changes

docs/conf.py Show resolved Hide resolved

docs/conf.py Outdated Show resolved Hide resolved

move metadata parsing to top of file for readability

bd80933

hbushouse approved these changes Dec 7, 2023

View reviewed changes

zacharyburnett merged commit 4205d60 into spacetelescope:master Dec 7, 2023
35 of 39 checks passed

zacharyburnett deleted the consolidate_build_config branch December 7, 2023 16:42

mcara reviewed Dec 7, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

move build configuration into `pyproject.toml` #6847

move build configuration into `pyproject.toml` #6847

zacharyburnett commented May 16, 2022 •

edited

Loading

codecov bot commented May 19, 2022 •

edited

Loading

zacharyburnett commented May 19, 2022

zacharyburnett commented Nov 17, 2023 •

edited

Loading

zacharyburnett commented Dec 6, 2023

hbushouse left a comment

zacharyburnett commented Dec 7, 2023

mcara Dec 7, 2023

move build configuration into pyproject.toml #6847

move build configuration into pyproject.toml #6847

Conversation

zacharyburnett commented May 16, 2022 • edited Loading

codecov bot commented May 19, 2022 • edited Loading

Codecov Report

zacharyburnett commented May 19, 2022

zacharyburnett commented Nov 17, 2023 • edited Loading

zacharyburnett commented Dec 6, 2023

hbushouse left a comment

Choose a reason for hiding this comment

zacharyburnett commented Dec 7, 2023

mcara Dec 7, 2023

Choose a reason for hiding this comment

move build configuration into `pyproject.toml` #6847

move build configuration into `pyproject.toml` #6847

zacharyburnett commented May 16, 2022 •

edited

Loading

codecov bot commented May 19, 2022 •

edited

Loading

zacharyburnett commented Nov 17, 2023 •

edited

Loading