setup.py → pyproject.toml

[DimitriPapadopoulos]

Fxies #288.

[CPBridge]

Thanks, looks good but I'll run a few careful tests before we merge

[CPBridge]

Thanks for taking the time to do this!

A couple of things:

1. It appears that the license (and less importantly the platforms) did not make it across from setup.py to pyproject.toml.
2. We should remove the requirements_doc.txt and requirements_test.txt as they are now redundant, right? Or is there some reason you left them in place?

[DimitriPapadopoulos]

1. The license is part of the classifiers:

       "License :: OSI Approved :: MIT License",
   

   I have not duplicated it in a license field because the Python Packaging User Guide reads:

   If you are using a standard, well-known license, it is not necessary to use this field. Instead, you should use one of the classifiers starting with License ::.

   Same for platforms, they are documented in the classifiers. There's no key dedicated to platforms anyway.

2. I've removed requirements_doc.txt and requirements_test.txt.

[CPBridge]

Thanks! That makes sense.

But now the github actions are failing because they depend on the old requirements_test.txt. Could you please make the simple change to this line of run_unit_tests.yml to fix and get the CI pipeline running again?

[DimitriPapadopoulos]

The CI jobs pass, I have also updated the documentation.

[CPBridge]

I have also updated the documentation.

Ah yes, good catch. Thanks for your help!

[DimitriPapadopoulos]

Unfortunately, I missed an occurrence of requirements_docs.txt:

highdicom/.readthedocs.yaml

Line 27 in 3f7a507

- requirements: requirements_docs.txt

[CPBridge]

Yeah I just noticed that too, I'll take care of it. Thanks!

[DimitriPapadopoulos]

Perhaps you need to restore requirements_docs.txt. It looks like pyproject.toml won't be supported by readthedocs:
readthedocs/readthedocs.org#8599

[DimitriPapadopoulos]

My wrong, this is covered by packages:

version: 2

python:
  install:
    - method: pip
      path: .
      extra_requirements:
        - docs

With the previous settings, Read the Docs will execute the next commands:

pip install .[docs]

[CPBridge]

Yup, I came across and implemented the same solution. Builds just passed on readthedocs