Skip to content

refactor: move project metadata to pyproject.toml#1678

Merged
wpbonelli merged 1 commit into
modflowpy:developfrom
mwtoews:pyproject-metadata
Jan 18, 2023
Merged

refactor: move project metadata to pyproject.toml#1678
wpbonelli merged 1 commit into
modflowpy:developfrom
mwtoews:pyproject-metadata

Conversation

@mwtoews
Copy link
Copy Markdown
Contributor

@mwtoews mwtoews commented Jan 11, 2023

This PR moves the project metadata from setup.cfg to pyproject.toml as described by PEP 621 and implemented with setuptools >= 61.

Note that this metadata was previously moved with #1267, but setuptools did not support PEP 621 at the time.

This is mostly a 1:1 transfer, with a few exceptions:

  • "platform" is removed, as it lists "Windows, Mac OS-X, Linux" which all are common. This is a setuptools-specific metadata, and has a limited real-world use, except to list obscure operating systems not listed by the existing Trove classifiers. See this Q/A for more.
  • Similar to "platform", some Trove classifiers are removed, as they seem to have limited use. E.g. the Operating System classifiers are uninteresting details, as it's common for Python packages to have wide support on different operating systems. But keep more useful metadata, e.g. supported Python versions: https://img.shields.io/pypi/pyversions/flopy.svg
  • The optional dependant vtk now has Python 3.11 files, so python_version<'3.11' was removed

The remaining flake8 configuration from setup.cfg is simply moved to it's own configuration file.

Due to a GitHub bug, dependants are not listed for this project. Simply repeating the project name in setup.py will resolve this issue.

@mwtoews mwtoews force-pushed the pyproject-metadata branch from f586591 to 4cead8b Compare January 11, 2023 04:05
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 11, 2023

Codecov Report

Merging #1678 (4cead8b) into develop (d99e0cc) will increase coverage by 0.0%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           develop   #1678   +/-   ##
=======================================
  Coverage     71.6%   71.6%           
=======================================
  Files          253     253           
  Lines        55881   55881           
=======================================
+ Hits         40053   40059    +6     
+ Misses       15828   15822    -6     
Impacted Files Coverage Δ
flopy/utils/get_modflow.py 65.3% <0.0%> (+1.4%) ⬆️

@wpbonelli
Copy link
Copy Markdown
Member

Tested building the package from this PR branch and all seems good. I don't have maintainer permissions on the flopy TestPyPI repo so couldn't test the upload (would it be possible to add me at some point @mwtoews?)

@wpbonelli wpbonelli merged commit 2e6a7e1 into modflowpy:develop Jan 18, 2023
@mwtoews mwtoews deleted the pyproject-metadata branch January 18, 2023 19:59
jdhughes-dev pushed a commit that referenced this pull request Jan 23, 2023
…#1677)

* (hotfix): avoid error with large totim in returning budget dataframes

* refactor: move project metadata to pyproject.toml (#1678)

* update(Modpath7): update path construction for modpath nam file (#1679)

* update(Modpath7): update path construction for modflow model files in nam file

* create relative path to flow model from modpath sim path

* ran isort and black

Co-authored-by: Mike Taves <mwtoews@gmail.com>
Co-authored-by: Joshua Larsen <jlarsen@usgs.gov>
wpbonelli pushed a commit that referenced this pull request Dec 2, 2024
The setup.py file was converted to a setuptools wrapper with #1678. This file is not used in this project, and modern pip/setuptools don't look for it anymore, so it can be cleaned up.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants