Skip to content

Add topic to read version from file #356

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
tomschr merged 1 commit into from
Feb 24, 2022
Merged

Add topic to read version from file #356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions changelog.d/340.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Describe how to get version from a file
1 change: 1 addition & 0 deletions docs/advanced/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ Advanced topics
display-deprecation-warnings
combine-pydantic-and-semver
convert-pypi-to-semver
version-from-file
23 changes: 23 additions & 0 deletions docs/advanced/version-from-file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.. _sec_reading_versions_from_file:

Reading versions from file
==========================

In cases where a version is stored inside a file, one possible solution
is to use the following function:

.. code-block:: python

from semver.version import Version

def get_version(path: str = "version") -> Version:
"""
Construct a Version from a file

:param path: A text file only containing the semantic version
:return: A :class:`Version` object containing the semantic
version from the file.
"""
with open(path,"r") as fh:
version = fh.read().strip()
return Version.parse(version)