PSA: xstatic 2.0.0 migration hints

[ThomasWaldmann]

It looks like "modernized" xstatic 2.0.0 can't be compatible with currently existing "legacy" xstatic-* resource packages, but needs all resource packages to be "modernized" also.

Also, "legacy" xstatic < 2.0.0 isn't compatible with the "modernized" resource packages, but only with the "legacy" resource packages.

Thus, I guess best way to deal with that for projects using xstatic is:

• pin all xstatic packages to the legacy versions (xstatic < 2 and xstatic-* to precisely whatever the latest legacy version is). that avoids that non-working mixups of legacy and modernized packages will get installed.
• help getting all xstatic-* resource packages modernized. guess the easiest way to do that is to:
  • take the latest legacy version,
  • re-release it including a wheel or add a wheel to last release (if that wasn't the case before),
  • modernize it and re-release it (without doing a version change of the contained software - that can be and should be done later)
• when all xstatic packages have modernized releases, change the version pinning to minimum requirements (xstatic >= 2 and < 3, and xstatic-* >= first modernized version)

How to modernize existing xstatic resource packages:

• pep420 namespace package, add pyproject.toml, bump version xstatic-bootstrap#3
• pep420 namespace package, add pyproject.toml, bump version xstatic-font-awesome#3

More details: #12

[ThomasWaldmann]

The existing xstatic-* resource packages usually do not require the xstatic main package (because it was technically not needed).

But we could add such a requirement to keep the legacy and modernized package sets apart from each other:

• require xstatic < 2 from legacy resource packages (would need re-releasing at least the latest legacy version only for that change and would not change any other, older released version)
• require xstatic >= 2 from modernized resource packages (if we would release xstatic 2.0.0 after all major resource pkgs have been updated, that would block installation of them, avoiding mixups)

[ThomasWaldmann]

I don't know exactly what's causing the problems, but my impression is that a single legacy package often works, but when you install multiple legacy or mix legacy and modernized, things break.

See also:

• DeprecationWarning: pkg_resources is deprecated as an API. #12 (comment)
• modernize: native namespace, pyproject.toml, py39+, src/, ... #14 (comment)

[ThomasWaldmann]

Note: the modernized xstatic main package code was just merged into master branch here.

Before creating a (pypi) release, I'ld like a bit more feedback concerning the migration.

I added a step concerning wheels, they seem to improve compatibility when using modernized xstatic package together with legacy xstatic-* packages.

[ThomasWaldmann]

#16 - list of legacy packages WITH a wheel.

[ThomasWaldmann]

https://github.com/moinwiki/moin/pull/1906/files example for pinning to legacy.

Do that if you want to be super careful and avoid any accidental breakage while we release xstatic 2.0.0 and modernize xstatic-* packages.

[roland-ruedenauer]

When do you plan to release version 2.0.0 ?