Skip to content

change VERSION to __version__ in the example #4590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 27, 2024
Merged

change VERSION to __version__ in the example #4590

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e21771d
change VERSION to __Version__ in the example
ChrisBarker-NOAA Aug 22, 2024
bffdf79
Update pyproject_config.rst
ChrisBarker-NOAA Aug 23, 2024
ed55d76
Update docs/userguide/pyproject_config.rst
abravalheri Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/userguide/pyproject_config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ corresponding entry is required in the ``tool.setuptools.dynamic`` table
dynamic = ["version", "readme"]
# ...
[tool.setuptools.dynamic]
version = {attr = "my_package.VERSION"}
version = {attr = "my_package.__version__"} # any module attribute compatible with ast.literal_eval
readme = {file = ["README.rst", "USAGE.rst"]}

In the ``dynamic`` table, the ``attr`` directive [#directives]_ will read an
Expand Down Expand Up @@ -280,7 +280,7 @@ not installed yet. You may also need to manually add the project directory to
directive for ``tool.setuptools.dynamic.version``.

.. [#attr] ``attr`` is meant to be used when the module attribute is statically
specified (e.g. as a string, list or tuple). As a rule of thumb, the
specified (e.g. as a string). As a rule of thumb, the
attribute should be able to be parsed with :func:`ast.literal_eval`, and
should not be modified or re-assigned.

Expand Down