search

wtclarke / nifti_mrs_tools

Software tools for the NIfTI-MRS data format
BSD 3-Clause "New" or "Revised" License
0 stars 5 forks source link

Unnecessary file nifti_mrs/standard/explanatory_doc/conf.py #24

Closed musicinmybrain closed 7 months ago

musicinmybrain commented 7 months ago

An unnecessary file nifti_mrs/standard/explanatory_doc/conf.py, the Doxygen configuration for the standard specification https://github.com/wtclarke/mrs_nifti_standard/, is included in both the sdists and wheels, when only nifti_mrs/standard/definitions.json is really needed or wanted. This isn’t particularly harmful, but it isn’t really right either.

$ python3.12 -m venv _e
$ . _e/bin/activate
(_e) $ pip install nifti-mrs
(_e) $ find _e/lib/python3.12/site-packages/nifti_mrs/standard/
_e/lib/python3.12/site-packages/nifti_mrs/standard/
_e/lib/python3.12/site-packages/nifti_mrs/standard/definitions.json
_e/lib/python3.12/site-packages/nifti_mrs/standard/explanatory_doc
_e/lib/python3.12/site-packages/nifti_mrs/standard/explanatory_doc/conf.py
_e/lib/python3.12/site-packages/nifti_mrs/standard/explanatory_doc/__pycache__
_e/lib/python3.12/site-packages/nifti_mrs/standard/explanatory_doc/__pycache__/conf.cpython-312.pyc
$ gh repo clone wtclarke/nifti_mrs_tools
$ cd nifti_mrs_tools
$ python3 -m build
$ tar -tzf dist/nifti_mrs-1.2.0.tar.gz | grep standard
nifti_mrs-1.2.0/src/nifti_mrs/standard/
nifti_mrs-1.2.0/src/nifti_mrs/standard/definitions.json
nifti_mrs-1.2.0/src/nifti_mrs/standard/explanatory_doc/
nifti_mrs-1.2.0/src/nifti_mrs/standard/explanatory_doc/conf.py

Expected:

$ python3.12 -m venv _e
$ . _e/bin/activate
(_e) $ pip install nifti-mrs
(_e) $ find _e/lib/python3.12/site-packages/nifti_mrs/standard/
_e/lib/python3.12/site-packages/nifti_mrs/standard/
_e/lib/python3.12/site-packages/nifti_mrs/standard/definitions.json
$ tar -tzf dist/nifti_mrs-1.2.0.tar.gz | grep standard
nifti_mrs-1.2.0/src/nifti_mrs/standard/
nifti_mrs-1.2.0/src/nifti_mrs/standard/definitions.json