Merge pull request #25 from tylercb/add_version

Add version
Bump version: 1.4.0 → 1.5.0

.bumpversion.cfg

@@ -1,6 +1,8 @@
 [bumpversion]
-current_version = 1.4.0
+current_version = 1.5.0
 commit = True
 tag = True
 
 [bumpversion:file:setup.py]
+
+[bumpversion:file:starred_repo_finder/__version__.py]

README.md

@@ -246,6 +246,14 @@ $ starred_repo_finder --limit=50 --format=markdown Ionaru/easy-markdown-editor >
 
 See [examples/ionaru-easy-markdown-editor.md](https://github.com/tylercb/starred_repo_finder/blob/main/examples/ionaru-easy-markdown-editor.md) for the output.
 
+## Tools
+
+Bump the version:
+
+```bash
+bumpversion minor
+```
+
 ## Acknowledgements
 
 This would not be possible without the following:

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="starred_repo_finder",
-    version="1.4.0",
+    version="1.5.0",
     description="A simple command line tool to find and explore GitHub repositories through stargazers for a given repository.",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",

starred_repo_finder/__version__.py

@@ -0,0 +1 @@
+__version__ = "1.5.0"

starred_repo_finder/cli.py

@@ -1,8 +1,10 @@
 import click
 from .starred_repo_finder import get_repos_starred_by_same_users, print_results
+from .__version__ import __version__
 
 
 @click.command()
+@click.version_option(version=__version__, prog_name="starred_repo_finder")
 @click.argument("repo_name")
 @click.option(
     "--limit",

tests/test_version.py

@@ -0,0 +1,19 @@
+import unittest
+from click.testing import CliRunner
+from starred_repo_finder.cli import cli
+from starred_repo_finder.__version__ import __version__
+
+
+class TestCLIVersion(unittest.TestCase):
+    def test_version_output(self):
+        """Test if `--version` option returns the current version."""
+        runner = CliRunner()
+        result = runner.invoke(cli, ["--version"])
+        expected_output = f"starred_repo_finder, version {__version__}\n"
+
+        self.assertEqual(result.exit_code, 0)
+        self.assertIn(expected_output, result.output)
+
+
+if __name__ == "__main__":
+    unittest.main()