dynamic version

[dpgaspar]

• I have searched the issues of this repo and believe that this is not a duplicate.
• I have searched the documentation and believe that my question is not covered.

Question

I'm migrating a project to poetry

I would like to make the version based on the contents of a file, say JSON or __init__.py any advice you can offer?

[finswimmer]

I'm looking for the exact same thing.

The reason for this is, that I need the version number within my package as well.

I could imagine somthing like this:

[tool.poetry]
name = "my_package"
version = {path = "/path/to/package.json"}

Where package.json must contain a key version:

{
  "version": "0.1.0"
}

[finswimmer]

Another way I could think of, is that there is in option for poetry version to write the bumped version to a __version__.py as well. Because this is a place where lots of people store their package version number as well. (poetry as well ;) )

[dmontagu]

I have been using (and loving) the trick from this comment: #144 (comment)

In order to adapt it to your own project, all you need to do is change x12_utils/__init__.py to the path to whatever file you want to contain your project's version number. (And maybe also change the path to pyproject.toml if necessary.)

Then you can run that make command (or shell script, if you use that approach) to have poetry set the version in pyproject.toml, and have sed set the version (output by poetry) in the version file.

The only restriction is that the same version string shouldn't show up in an unrelated way in the file (e.g., don't run it on a file that includes version numbers for all of your dependencies).

[finswimmer]

Thanks for pointing me to that issue!

Having a custom script, that do the version bumping in all files, is one workaround, but would introduce a new "tool" beside poetry. But I like other solutions mentioned there and in linked issues:

• using pkg_resources
• using importlib_metadata

With the last one, one can get all metadata shipped with the package and is intended to get integrated in python3.8 (before one has to install it via pip).

To think in a bigger context: The underlying question in all 3 issues is how and where to store metadata that is needed by poetry during build process and also by the package itself, in a way that only one location is needed.

The most cleanest way seems to me having the metadata in the pyproject.toml and using one of the mentioned packages to fetch metadata during runtime of the package.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

Closing this issue automatically because it has not had any activity since it has been marked as stale. If you think it is still relevant and should be addressed, feel free to open a new one.

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.