Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

move build configuration into pyproject.toml #1661

Merged
merged 5 commits into from
May 3, 2023

Conversation

zacharyburnett
Copy link
Contributor

@zacharyburnett zacharyburnett commented Sep 20, 2022

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.

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set?
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

@github-actions github-actions bot added documentation Explanation of code and concepts testing labels Sep 20, 2022
Copy link
Contributor

@pllim pllim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is a little too early for this. You will need a very new version of pip.

We should wait for several more releases from Python org.

@codecov
Copy link

codecov bot commented Apr 14, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (4b72cd3) 91.75% compared to head (708139b) 91.75%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1661   +/-   ##
=======================================
  Coverage   91.75%   91.75%           
=======================================
  Files         147      147           
  Lines       16186    16186           
=======================================
  Hits        14852    14852           
  Misses       1334     1334           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@rosteen
Copy link
Collaborator

rosteen commented May 2, 2023

I resolved the conflicts, let's see if the tests pass this time...I installed in a few environments locally and everything seemed to work fine.

@rosteen rosteen added the no-changelog-entry-needed changelog bot directive label May 3, 2023
Copy link
Collaborator

@rosteen rosteen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had to kick the tests a couple times, but they finally passed. I pushed one fix to the sphinx config section, I think this is good to go now.

@rosteen rosteen removed the no-changelog-entry-needed changelog bot directive label May 3, 2023
@rosteen rosteen added this to the 3.5 milestone May 3, 2023
Copy link
Collaborator

@duytnguyendtn duytnguyendtn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Local install works on my end. Installation is successful, can import jdaviz and the SpecvizExample notebook works great. Thanks for the contribution!

@rosteen rosteen merged commit 14e9cfb into spacetelescope:main May 3, 2023
@zacharyburnett zacharyburnett deleted the pep621 branch May 3, 2023 17:28
@pllim pllim mentioned this pull request Aug 1, 2023
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Explanation of code and concepts testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants