Automatically generated by python-semantic-release ([`9a2798d`](https://github.com/madpah/serializable/commit/9a2798d23de90ed36a4aecb4ec955cbe037a4089))
* bump to python-semantic-release/python-semantic-releasev7.34.6
Signed-off-by: Jan Kowalleck <jan.kowalleckgmail.com> ([`68d229e`](https://github.com/madpah/serializable/commit/68d229e62d049713ade8e08487f491683b0bb0f9))
* Merge pull request 7 from claui/fix-top-level-license
Keep `LICENSE` in `.dist-info` when building wheel ([`9bc4abc`](https://github.com/madpah/serializable/commit/9bc4abccc9cabed5f9808101a8d25717b86f01b4))
* Keep `LICENSE` in `.dist-info` when building wheel
Poetry automatically detects and includes `LICENSE` files in
`….dist-info/` when it builds a wheel.
If `LICENSE` is also declared as a pattern in Poetry’s `include` list in
`pyproject.toml`, then the file will appear in the root directory of the
wheel, too:
plain
Path = /var/lib/aurbuild/x86_64/claudia/build/python-py-serializable/src/serializable-0.12.0/dist/py_serializable-0.12.0-py3-none-any.whl
Type = zip
Physical Size = 22557
Date Time Attr Size Compressed Name
------------------- ----- ------------ ------------ ------------------------
1980-01-01 00:00:00 ..... 11357 3948 LICENSE
1980-01-01 00:00:00 ..... 52795 9275 serializable/__init__.py
1980-01-01 00:00:00 ..... 3382 923 serializable/formatters.py
1980-01-01 00:00:00 ..... 3690 1180 serializable/helpers.py
1980-01-01 00:00:00 ..... 153 117 serializable/py.typed
1980-01-01 00:00:00 ..... 11357 3948 py_serializable-0.12.0.dist-info/LICENSE
1980-01-01 00:00:00 ..... 3845 1449 py_serializable-0.12.0.dist-info/METADATA
1980-01-01 00:00:00 ..... 88 85 py_serializable-0.12.0.dist-info/WHEEL
2016-01-01 00:00:00 ..... 718 408 py_serializable-0.12.0.dist-info/RECORD
------------------- ----- ------------ ------------ ------------------------
2016-01-01 00:00:00 87385 21333 9 files
Note how the wheel contains two identical copies of your `LICENSE` file:
one copy in the `….dist-info/` directory, picked up automatically by
Poetry, and a second copy in the root directory of the wheel.
Including a generically-named file directly in a wheel’s root directory
may cause problems:
1. The `LICENSE` file is going to turn up at the top level of
`site-packages` directly. That’s misleading, because anyone who’d
browse `site-packages` might conclude that the license be valid for
all packages, not just `serializable`, which is incorrect.
2. Having generic files at the top level of `site-packages` causes
conflicts with other wheels that happen to include the same file.
For example, I’ve had `LICENSE` files coming from two different
wheels, excluding `serializable`, sitting at the top level of my
`site-packages` directory so I could install only one of them.
The fix is to remove the `LICENSE` pattern from the `include` list.
Poetry automatically picks up files named `LICENSE`, and drops them
either into an sdist’s root directory (when building an sdist) or into
`py_serializable-[version].dist-info/` (when building a wheel).
Signed-off-by: Claudia <clauiusers.noreply.github.com> ([`31e4003`](https://github.com/madpah/serializable/commit/31e4003e949b73a4cd7c18aac458200888c1a0f2))
* Merge branch &39;main&39; of github.com:madpah/serializable ([`c1e8fd8`](https://github.com/madpah/serializable/commit/c1e8fd840b9e89c36f36304342cc6f9be8cc7d26))