Merge pull request #5 from Vini2/main

Add click version options and update setup.py to include README.md info

{{cookiecutter.project_slug}}/setup.py

@@ -11,6 +11,17 @@ def get_version():
         )
     ) as f:
         return f.readline().strip()
+
+
+def get_description():
+    with open("README.md", "r") as fh:
+        long_description = fh.read()
+    return long_description
+
+
+def get_data_files():
+    data_files = [(".", ["README.md"])]
+    return data_files
 
 
 CLASSIFIERS = [
@@ -33,9 +44,12 @@ def get_version():
     url="{{cookiecutter.project_url}}",
     python_requires="{{cookiecutter.min_python_version}}",
     description="{{cookiecutter.project_description}}",
+    long_description=get_description(),
+    long_description_content_type="text/markdown",
     version=get_version(),
     author="{{cookiecutter.full_name}}",
     author_email="{{cookiecutter.email}}",
+    data_files=get_data_files(),
     py_modules=["{{cookiecutter.project_slug}}"],
     install_requires=[
         "snakemake{{cookiecutter.snakemake_version}}",

{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/__main__.py

@@ -10,7 +10,7 @@
 
 from .util import (
     snake_base,
-    print_version,
+    get_version,
     default_to_output,
     copy_config,
     run_snakemake,
@@ -82,8 +82,11 @@ def common_options(func):
 @click.group(
     cls=OrderedCommands, context_settings=dict(help_option_names=["-h", "--help"])
 )
+@click.version_option(get_version(), "-v", "--version", is_flag=True)
 def cli():
-    """For more options, run:
+    """{{cookiecutter.project_description}}
+    \b
+    For more options, run:
     {{cookiecutter.project_slug}} command --help"""
     pass
 
@@ -150,7 +153,6 @@ def citation(**kwargs):
 
 
 def main():
-    print_version()
     cli()
 
 

{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/util.py

@@ -22,10 +22,10 @@ def snake_base(rel_path):
     return os.path.join(os.path.dirname(os.path.realpath(__file__)), rel_path)
 
 
-def print_version():
+def get_version():
     with open(snake_base("{{cookiecutter.project_slug}}.VERSION"), "r") as f:
         version = f.readline()
-    echo_click("\n" + "{{cookiecutter.project_name}} version " + version + "\n")
+    return version
 
 
 def echo_click(msg, log=None):