mgedmin / mgedmin/irclog2html

Packaging question: to ship tests or not?

Open
#36 0 comments 0 reactions 0 assignees View on GitHub
question
Dominant language
Python
Stars
89
Forks
24
PR merge metrics
No merged PRs in 30d

Description

Noticed this while doing `make release`

````
/tmp/build-env-ax2rb14o/lib/python3.12/site-packages/setuptools/command/build_py.py:218: _Warning: Package 'irclog2html.tests' is absent from the `packages` configuration.
!!

********************************************************************************
############################
# Package would be ignored #
############################
Python recognizes 'irclog2html.tests' as an importable package[^1],
but it is absent from setuptools' `packages` configuration.

This leads to an ambiguous overall configuration. If you want to distribute this
package, please make sure that 'irclog2html.tests' is explicitly added
to the `packages` configuration field.

Alternatively, you can also rely on setuptools' discovery methods
(for example by using `find_namespace_packages(...)`/`find_namespace:`
instead of `find_packages(...)`/`find:`).

You can read more about "package discovery" on setuptools documentation page:

- https://setuptools.pypa.io/en/latest/userguide/package_discovery.html

If you don't want 'irclog2html.tests' to be distributed and are
already explicitly excluding 'irclog2html.tests' via
`find_namespace_packages(...)/find_namespace` or `find_packages(...)/find`,
you can try to use `exclude_package_data`, or `include-package-data=False` in
combination with a more fine grained `package-data` configuration.

You can read more about "package data files" on setuptools documentation page:

- https://setuptools.pypa.io/en/latest/userguide/datafiles.html

[^1]: For Python, any directory (with suitable naming) can be imported,
even if it does not contain any `.py` files.
On the other hand, currently there is no concept of package data
directory, all directories are treated like packages.
********************************************************************************

!!
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by running `make release` and inspect the packaging configuration that controls setuptools package discovery. Determine whether `irclog2html.tests` should be included in distributions or excluded, then verify the chosen behavior by rebuilding and confirming the warning is resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.