Closed justinvasel closed 4 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
.
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.
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.
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 useautoapi~=2.0.1
orautoapi~=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!
Overview
Project dependencies in both
snews_pt
andsnews_cs
could use some TLC.snews_cs
depends onsnews_pt
, so let's handle this one first, and then move on to tidying up thesnews_cs
side.Here are some issues I've spotted:
snews_cs
depends onsnews_pt
, which creates some version mis-match issues for dependencies that they share in common; bringing dependencies up-to-date in both packages should address most of these issues.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
snews_pt
currently supports Python 3.7 and up.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 ofrequirements.txt
andsetup.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 bysnews_pt
at all. However, some may be command-line tools that developers use manually in the course of testing, linting, etc.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
setup.py
requirements.txt
with only the "Required" group packages from abovesetup.py
with "dev" and "doc" group packages from above