Add a py.typed

[sthiele]

For clintest there was recently the request to add a py.typed file to enable type checking in other packages. I wasn't aware that this is necessary.
Should this also be part of the template?

[MaxOstrowski]

Very interesting. Is
include_package_data = True
and

[options.packages.find]
where = src

enough to include this in the installation process ?

[MaxOstrowski]

Thats an opinion and I agree.
I haven't found any criticism on setuptools-scm and I still think its odd to rely on the revisioning tool for building the package.
@susuhahnml @rkaminsk any opinion about it ?

[rkaminsk]

I think it's fine. The source tarball does not need git. We only need git to create the source tarball.

[rkaminsk]

I'll go over the PRs next and make sure the py.typed thing is added. It probably takes less time to fix than discussing about it.

[susuhahnml]

What do you mean by "rely on the revisioning tool for building the package" sorry, I am not following :(

[rkaminsk]

Packaging in Python sucks.

Packaging pure Python packages is actually not that complicated. Of course one has to take care of all the optional things one wants to add. It only gets (really) messy once you want to ship projects that need a compiler. However, there has been quite some development to even make this possible these days.

[sthiele]

@susuhahnml because

setuptools-scm extracts Python package versions from git or hg metadata instead of declaring them as the version argument or in an SCM managed file.

This means if we switch to another versioning tool, then packaging also needs to be adjusted.
My instincts tell me to reduce unnecessary dependencies ... but this seems to be a thing 🤷

[rkaminsk]

At the moment, we do not use it to extract the version - just to get the list of files for the source tarball.

In my experience, this does exactly what is required by just adding a tiny package. However, there are other ways. We could for example use manifest files. In my experience, this easily leads to broken source tarballs.

I would like to keep it as is.