Fix #410 Export all names in __all__ variable

* Export all semver names in `__all__` variable. * Fix linting issues
python-semver · Jun 14, 2023 · 17bc257 · 17bc257
1 parent 9227686
commit 17bc257
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 4 deletions.
diff --git a/changelog.d/410.bugfix.rst b/changelog.d/410.bugfix.rst
@@ -0,0 +1 @@
+Export functions properly using `__all__` in `__init__.py`. 
diff --git a/src/semver/__init__.py b/src/semver/__init__.py
@@ -1,5 +1,5 @@
 """
-semver package major release 3.
+Semver package major release 3.
 
 A Python module for semantic versioning. Simplifies comparing versions.
 """
@@ -37,3 +37,36 @@
     __maintainer_email__,
     SEMVER_SPEC_VERSION,
 )
+
+__all__ = [
+    "bump_build",
+    "bump_major",
+    "bump_minor",
+    "bump_patch",
+    "compare",
+    "bump_prerelease",
+    "finalize_version",
+    "format_version",
+    "match",
+    "max_ver",
+    "min_ver",
+    "parse",
+    "parse_version_info",
+    "replace",
+    "cmd_bump",
+    "cmd_compare",
+    "cmd_nextver",
+    "cmd_check",
+    "createparser",
+    "process",
+    "main",
+    "Version",
+    "VersionInfo",
+    "__version__",
+    "__author__",
+    "__maintainer__",
+    "__author_email__",
+    "__description__",
+    "__maintainer_email__",
+    "SEMVER_SPEC_VERSION",
+]
diff --git a/src/semver/cli.py b/src/semver/cli.py
@@ -61,7 +61,7 @@ def cmd_check(args: argparse.Namespace) -> None:
 
 def cmd_compare(args: argparse.Namespace) -> str:
     """
-    Subcommand: Compare two versions
+    Subcommand: Compare two versions.
 
     Synopsis: compare <VERSION1> <VERSION2>
 

diff --git a/src/semver/version.py b/src/semver/version.py
@@ -64,8 +64,8 @@ class Version:
     See specification at https://semver.org.
 
     :param major: version when you make incompatible API changes.
-    :param minor: version when you add functionality in
-                  a backwards-compatible manner.
+    :param minor: version when you add functionality in a backwards-
+        compatible manner.
     :param patch: version when you make backwards-compatible bug fixes.
     :param prerelease: an optional prerelease string
     :param build: an optional build string