bump version, merge branch 'devel'

Author: casperdcl

.github/workflows/comment-bot.yml

@@ -0,0 +1,47 @@
+name: Comment Bot
+on:
+  issue_comment:
+    types: [created, edited]
+  pull_request_review_comment:
+    types: [created, edited]
+
+jobs:
+  tag:
+    if: startsWith(github.event.comment.body, '/tag ')
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: React Seen
+      uses: actions/github-script@v2
+      with:
+        script: |
+          post = context.eventName === 'issue_comment' ? github.reactions.createForIssueComment : github.reactions.createForPullRequestReviewComment
+          post({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            comment_id: context.payload.comment.id,
+            content: "eyes",
+          })
+    - name: Tag Commit
+      run: |
+        git config user.name tag-bot
+        git config user.email [email protected]
+        git tag $(echo "$BODY" | awk '{print $2" "$3}')
+        git push --tags
+      env:
+        BODY: ${{ github.event.comment.body }}
+    - name: React Success
+      uses: actions/github-script@v2
+      with:
+        script: |
+          post = context.eventName === 'issue_comment' ? github.reactions.createForIssueComment : github.reactions.createForPullRequestReviewComment
+          post({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            comment_id: context.payload.comment.id,
+            content: "rocket",
+          })
+  always:
+    runs-on: ubuntu-latest
+    steps:
+    - run: echo prevent failure when other jobs are skipped

.gitignore

@@ -2,6 +2,7 @@
 
 # Packages
 shtab.egg-info/
+/.eggs/
 /build/
 /dist/
 

CONTRIBUTING.md

@@ -35,3 +35,13 @@ string snippets without clashing between python's `str.format` and shell
 parameter expansion.
 
 The generated shell code itself is also meant to be readable.
+
+## Releases
+
+Tests and deployment are handled automatically by continuous integration. Simply
+tag a commit `v{major}.{minor}.{patch}` and wait for a draft release to appear
+at <https://github.com/iterative/shtab/releases>. Tidy up the draft's
+description before publishing it.
+
+Note that tagging a release is possible by commenting `/tag vM.m.p HASH` in an
+issue or PR.

setup.py

@@ -11,7 +11,6 @@
 
 __author__ = "Casper da Costa-Luis <[email protected]>"
 __licence__ = "Apache-2.0"
-__version__ = "1.0.4"
 src_dir = os.path.abspath(os.path.dirname(__file__))
 
 # Execute Makefile commands if specified
@@ -31,7 +30,8 @@
     requirements_dev = fd.readlines()
 setup(
     name="shtab",
-    version=__version__,
+    use_scm_version=True,
+    setup_requires=["setuptools_scm"],
     description="Automatically generate shell tab completion scripts"
     " for python CLI apps",
     long_description=README_rst,

shtab/__init__.py

@@ -14,6 +14,31 @@
 )
 from functools import total_ordering
 
+
+def get_version_dist(name=__name__):
+    from pkg_resources import DistributionNotFound, get_distribution
+
+    try:
+        return get_distribution(name).version
+    except DistributionNotFound:
+        return "UNKNOWN"
+
+
+try:
+    from setuptools_scm import get_version
+except ImportError:
+    from os import path
+
+    ROOT = path.abspath(path.dirname(path.dirname(__file__)))
+    if path.exists(path.join(ROOT, ".git")):
+        __version__ = "UNKNOWN - please install setuptools_scm"
+    else:
+        __version__ = get_version_dist()
+else:
+    try:
+        __version__ = get_version(root="..", relative_to=__file__)
+    except LookupError:
+        __version__ = get_version_dist()
 __all__ = ["Optional", "Required", "Choice", "complete"]
 log = logging.getLogger(__name__)
 

shtab/main.py

@@ -4,7 +4,7 @@
 import logging
 from importlib import import_module
 
-from . import complete
+from . import __version__, complete
 
 log = logging.getLogger(__name__)
 
@@ -14,6 +14,9 @@ def get_main_parser():
     parser.add_argument(
         "parser", help="importable parser (or fuction returning parser)"
     )
+    parser.add_argument(
+        "--version", action="version", version="%(prog)s " + __version__
+    )
     parser.add_argument(
         "-s", "--shell", default="bash", choices=["bash", "zsh"]
     )