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.

Sign up for GitHub

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

Bump min python version to 3.10 and update metadata #318

Merged
merged 2 commits into from
Sep 26, 2024
Merged

Bump min python version to 3.10 and update metadata #318

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
856a1c7
Bump 3.10 and update metadata
AntObi Sep 26, 2024
094abf3
Update README and version number
AntObi Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
strategy:
fail-fast: false
matrix:
python-version: ["3.9","3.10","3.11","3.12"]
python-version: ["3.10","3.11","3.12"]
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Update Documentation to Reflect Python 3.10+ Requirement

The README currently states that the project is tested using Python 3.9+, which conflicts with the CI workflow where Python 3.9 has been removed from the test matrix. Please update the README to specify that the project requires Python 3.10 or higher to ensure consistency and clarity for users.

🔗 Analysis chain

Approved: Python version matrix update aligns with PR objectives

The removal of Python 3.9 from the test matrix is consistent with the PR's goal of dropping support for Python 3.9 and aligning with pymatgen and other NumFOCUS stack libraries. This change appropriately reflects the new minimum Python version requirement of 3.10.

To ensure this change is properly documented, please run the following script:

If the script doesn't return any results or shows outdated information, please update the project's README or documentation to clearly state the new minimum Python version requirement.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the README or documentation has been updated to reflect the new Python version requirement.

# Test: Search for mentions of Python version requirements
rg --type md --type rst "Python (version|>=|>|3\.(9|10))"

Length of output: 138

os: [ubuntu-latest,macos-latest,windows-latest]

runs-on: ${{matrix.os}}
Expand Down
11 changes: 5 additions & 6 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
__copyright__ = (
"Copyright Daniel W. Davies, Adam J. Jackson, Keith T. Butler (2019)"
)
__version__ = "2.7"
__version__ = "2.7.1"
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Consider a major version increment for breaking changes

The version number has been updated from 2.7 to 2.7.1, which typically indicates a patch release. However, the PR description mentions a breaking change (dropping support for Python 3.9). Breaking changes usually warrant a major version increment.

Consider updating the version to 3.0.0 to reflect the breaking change:

-__version__ = "2.7.1"
+__version__ = "3.0.0"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
__version__ = "2.7.1"
__version__ = "3.0.0"

__maintainer__ = "Anthony O. Onwuli"
__maintainer_email__ = "[email protected]"
__date__ = "August 30 2024"
__date__ = "September 26 2024"


import os
Expand Down Expand Up @@ -52,17 +52,16 @@
test_suite="smact.tests.test",
install_requires=[
"scipy",
"numpy<2",
"numpy",
"spglib",
"pymatgen>=2024.2.20,<2024.8.8",
"pymatgen>=2024.2.20",
"ase",
"pandas",
"pathos",
"typing-extensions",
],
classifiers=[
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
Expand All @@ -73,5 +72,5 @@
"Topic :: Scientific/Engineering",
"Topic :: Scientific/Engineering :: Chemistry",
],
python_requires=">=3.9",
python_requires=">=3.10",
)