search

SNEWS2 / SNEWS_Publishing_Tools

Publishing Tool for SNEWS
BSD 3-Clause "New" or "Revised" License
2 stars 2 forks source link

Cleaning Up Project Dependencies #91

Closed justinvasel closed 4 months ago

justinvasel commented 6 months ago

Overview

Project dependencies in both snews_pt and snews_cs could use some TLC. snews_cs depends on snews_pt, so let's handle this one first, and then move on to tidying up the snews_cs side.

Here are some issues I've spotted:

I've done a quick audit of snews_pt package requirements, and came up with the recommendations below. Hoping to get the group's input on this, particularly whether removing any of the packages I've recommended below will disrupt anyone's workflow.

Here is a list of related issues we could close out with these changes: SNEWS PT https://github.com/SNEWS2/SNEWS_Publishing_Tools/issues/78

SNEWS CS https://github.com/SNEWS2/SNEWS_Coincidence_System/issues/94 https://github.com/SNEWS2/SNEWS_Coincidence_System/issues/91 https://github.com/SNEWS2/SNEWS_Coincidence_System/issues/55 https://github.com/SNEWS2/SNEWS_Coincidence_System/issues/8 https://github.com/SNEWS2/SNEWS_Coincidence_System/issues/5

Please leave any comments/questions/concerns you have about these recommendations in the chat and we can iterate. Once we've had a chance to discuss, I can submit a PR with whatever changes we decided on.

Minimum Supported Versions

Python

CONTEXT

RECOMMENDATION snews_pt should drop support for Python versions 3.7 and 3.8, and should consider dropping support for 3.9 and 3.10 if current SNEWS experiments have access to 3.11 or 3.12 installations.

Packages

CONTEXT The table below lists snews_pt package dependencies based on the contents of requirements.txt and setup.py. Some packages are unnecessary because they are second- or third-order dependencies, and many are out of date. Some packages don't appear to be used by snews_pt at all. However, some may be command-line tools that developers use manually in the course of testing, linting, etc.

Group Package Current Recommended Used in code?
Required attrs >=21.4.0 REMOVE NO
Required click >=8.1.2 ~=8.1 YES
Required docutils ==0.17.1 REMOVE NO
Required fixtures ==3.0.0 REMOVE NO
Required hop-client ==0.8.0 ~=0.8 YES
Required inquirer >=2.8.0 ~=2.8 YES
Required ipython ~=7.32.0 ~=8.7 YES
Required mock ==4.0.3 REMOVE NO
Required myst_parser ==0.16.1 ~=2.0 YES
Required nose ==1.3.7 REMOVE NO
Required numpy >=1.22.3 ~=1.26 YES
Required python-dotenv >=0.19.2 ~=0.19 YES
Required setuptools >=62.1.0 ~=69.0 YES
Required six ==1.14.0 REMOVE NO
Required testrepository ==0.0.20 REMOVE NO
Required testresources ==2.0.1 REMOVE NO
Required testscenarios ==0.5.0 REMOVE NO
Required testtools ==2.5.0 REMOVE NO
Required wheel ==0.34.2 ~=0.42 YES
dev virtualenv ==20.13.0 ~=20.13 YES
dev autopep8 (any) REMOVE NO
dev flake8 (any) REMOVE NO
dev mongomock (any) REMOVE NO
dev pytest >=5.0, <5.4 ~=8.0 YES
dev pytest-console-scripts (any) ~=1.4 UNKNOWN
dev pytest-cov (any) ~=4.1 UNKNOWN
dev pytest-mongodb (any) ~=2.4 UNKNOWN
dev pytest-runner (any) ~=6.0 UNKNOWN
dev twine (any) REMOVE NO
dev schedule (any) REMOVE NO
doc autoapi (any) ~=2.0 YES
doc myst_parser (any) ~=2.0 YES
doc sphinx (any) ~=7.2 YES
doc sphinx-autoapi ==1.8.4 ~=3.0 YES
doc sphinx_rtd_theme ==1.0.0 ~=2.0 YES
doc sphinxcontrib-programoutput ==0.17 ~=0.17 YES

RECOMMENDATION Upgrade or remove packages based on the recommended column in the table above. In most cases, allow use of the latest minor version, but don't allow use of any major versions that are larger than the listed one.

Implementation

  1. Collect feedback on inclusion/removal of packages listed in the above table
  2. Updated supported python version in setup.py
  3. Update requirements.txt with only the "Required" group packages from above
  4. Update setup.py with "dev" and "doc" group packages from above
  5. Update any relevant documentation
  6. Confirm tests pass and docs build
  7. Merge PR and cut new release
sybenzvi commented 6 months ago

Looks great @justinvasel. Only comment is that autoapi~=8.1 doesn't exist, so instead we should use autoapi~=2.0.1 or autoapi~=2.0.

sybenzvi commented 6 months ago

Readthedocs is now working again (see here). Note that I created docs/requirements.txt just to test everything; we could copy it to the source root and just use the package-level readthedocs for both documentation and installation.

KaraMelih commented 6 months ago

I just got back and started looking into documentation issues/PRs. Seems like most of it (if not all) is sorted out. Just in case, I added @sybenzvi as a maintainer on both RTD pages. I could not find @justinvasel if you have an account I can also add you as a maintainer.

justinvasel commented 6 months ago

TL;DR: I submitted PR #96 to address this. Looking for folks to test and make sure everything works as expected on their own machines.

Are any experiments actively using this package to report to SNEWS? If so, we should verify they can support python 3.11 and 3.12 before merging and tagging a new release. If not, let's push it out before they do!

===

Looks great @justinvasel. Only comment is that autoapi~=8.1 doesn't exist, so instead we should use autoapi~=2.0.1 or autoapi~=2.0.

Thanks Segev; I updated the table accordingly.

I just got back and started looking into documentation issues/PRs. Seems like most of it (if not all) is sorted out. Just in case, I added @sybenzvi as a maintainer on both RTD pages. I could not find @justinvasel if you have an account I can also add you as a maintainer.

I created an account there just now, so feel free to add me as a maintainer. Thanks!