Merge pull request #356 from tomschr/feature/340-doc-version-file-open

tomschr · web-flow · commit d06388727caa · 2022-02-24T21:44:22.000+01:00
Add topic to read version from file
diff --git a/changelog.d/340.doc.rst b/changelog.d/340.doc.rst
@@ -0,0 +1 @@
+Describe how to get version from a file
diff --git a/docs/advanced/index.rst b/docs/advanced/index.rst
@@ -9,3 +9,4 @@ Advanced topics
     display-deprecation-warnings
     combine-pydantic-and-semver
     convert-pypi-to-semver
+    version-from-file
diff --git a/docs/advanced/version-from-file.rst b/docs/advanced/version-from-file.rst
@@ -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)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Describe how to get version from a file`