feat!: renaming the python module

[santiagorr]

Dear py-serializable developers,

I am working on packaging py-serializable for debian (especially because it is a dependency of cyclonedx-python-lib), and I would like to kindly ask you to consider renaming the python module.

Unfortunately, there is another serializable module, packaged already in debian as python-serializable. serializable and py-serializable install their files under the serializable module, so they are not co-installable. And giving serializable is already found in the debian archive (but it is also valid installing via pip), I am taking the liberty to ask to you to rename the module. pyserializable could be an option.

I know this creates issues for projects/modules/libraries depending on py-serializable, but I cannot think about other easier approach, if co-installability is required.

Thank you!

[jkowalleck]

i could imagine renaming the installed package py_serializable could help prevent confusion.
this way, the runtime-package would have the same name as the PyPI-package.

@madpah, how do you feel about this?

[madpah]

Not against it @jkowalleck.

[jkowalleck]

I'd let this sink in,
and will work on a solution early 2025

[jkowalleck]

possible migration path, for the upcoming breaking change:

try:
  import serializable
  from serializable import ViewType, XmlArraySerializationType, XmlStringSerializationType
  from serializable.helpers import BaseHelper, Iso8601Date
except ImportError:
  import py_serializable as serializable
  from py_serializable import ViewType, XmlArraySerializationType, XmlStringSerializationType
  from py_serializable.helpers import BaseHelper, Iso8601Date

[jkowalleck]

this feature is in preview

• diff: main...refactor/rename-installable-py_serializable
• docs: https://py-serializable.readthedocs.io/en/refactor-rename-installable-py_serializable/
• GH: https://github.com/madpah/serializable/releases/tag/v2.0.0-alpha.1
• PyPI: https://pypi.org/project/py-serializable/2.0.0a1/

(planning on a test-integration in https://pypi.org/project/cyclonedx-python-lib/ soon)

[santiagorr]

Awesome, thank you!

[jkowalleck]

released via https://github.com/madpah/serializable/releases/tag/v2.0.0

[jkowalleck]

it might still need some time until the new version is used downstream everywhere.
see for example CycloneDX/cyclonedx-python-lib#775