Add CMakeLists.txt (etc...) to sdist

[tlambert03]

#89 added the sdist to pypi, which is great. However, in trying to build this package on conda-forge, I pulled the sdist from pypi and tried to build, but the sdist doesn't contain CMakeLists.txt (and perhaps other things) required to actually build the source.

error

Building wheels for collected packages: aicspylibczi
  Created temporary directory: /tmp/pip-wheel-nnka06mp
  Running command /home/conda/staged-recipes/build_artifacts/aicspylibczi_1633099207316/_h_env_placehold_placehold_placehold_placehold_placehold_placehold_placehold_placehold_placehold_placehold_placehold_placehold_placehold_placehold_placehold_placehold_placehold_placehol/bin/python -u -c 'import io, os, sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-req-build-o13na_jo/setup.py'"'"'; __file__='"'"'/tmp/pip-req-build-o13na_jo/setup.py'"'"';f = getattr(tokenize, '"'"'open'"'"', open)(__file__) if os.path.exists(__file__) else io.StringIO('"'"'from setuptools import setup; setup()'"'"');code = f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-nnka06mp
  Building wheel for aicspylibczi (setup.py): started
  Destination directory: /tmp/pip-wheel-nnka06mp
  running bdist_wheel
  running build
  running build_py
  creating build
  creating build/lib.linux-x86_64-3.8
  creating build/lib.linux-x86_64-3.8/aicspylibczi
  copying aicspylibczi/__init__.py -> build/lib.linux-x86_64-3.8/aicspylibczi
  copying aicspylibczi/types.py -> build/lib.linux-x86_64-3.8/aicspylibczi
  copying aicspylibczi/CziFile.py -> build/lib.linux-x86_64-3.8/aicspylibczi
  copying aicspylibczi/_version.py -> build/lib.linux-x86_64-3.8/aicspylibczi
  running egg_info
  writing aicspylibczi.egg-info/PKG-INFO
  writing dependency_links to aicspylibczi.egg-info/dependency_links.txt
  writing requirements to aicspylibczi.egg-info/requires.txt
  writing top-level names to aicspylibczi.egg-info/top_level.txt
  reading manifest file 'aicspylibczi.egg-info/SOURCES.txt'
  adding license file 'LICENSE'
  writing manifest file 'aicspylibczi.egg-info/SOURCES.txt'
  running build_ext
  CMake Error: The source directory "/tmp/pip-req-build-o13na_jo" does not appear to contain CMakeLists.txt.

I can use the tar.gz from the github releases for now, but it would be nice to make the sdist fully "build-competent"

[toloudis]

ok I think the sdist wants to see a MANIFEST.in file that lists out all the source files to be included. (reference: pytorch/pytorch#52843)

[tlambert03]

manifest.in is one option (the "classic distutils option") for declaring what should get into the sdist, but if you're using setuptools, it gets slightly more complicated. suggest reading this page: https://setuptools.pypa.io/en/latest/userguide/datafiles.html and note the include_package_data and package_data options.

Ultimately, as many times as I've read through those docs, I generally end up doing this by some degree of trial and error. running python setup.py sdist bdist_wheel over and over again, inspecting both the wheel and the sdist, and modifying setup.py and manifest.in until I'm happy.

[toloudis]

I have attempted to do this in the aicspylibczi 3.1.1 build. Still untested but the sdist now has a more complete attempt to bundle all source code. (Gotta figure out how to test this!)

[psobolewskiPhD]

FYI, there is now a conda-forge package!
https://github.com/conda-forge/aicspylibczi-feedstock

[toloudis]

I wonder if we can say this issue is resolved?

[psobolewskiPhD]

the conda-forge recipe uses the sdist from pypi:
https://github.com/conda-forge/aicspylibczi-feedstock/blob/fd7909ef1562ae99db96fcc8c49f7c800becc2af/recipe/meta.yaml#L9
So I think so?

[psobolewskiPhD]

(macOS arm64 migrator is failing (conda-forge/aicspylibczi-feedstock#5) , but i think that is unrelated and there are packages for x86)

[psobolewskiPhD]

Actually, that migrator error shows the CMakefile.txt is properly included, because the error is with compatibility of cmake versions!
(conda-forge ci appears to be using cmake 4.0.2 h74e3db0_0)