Add GitHub action to publish Python package on tag push

Author: NeverMendel

.github/workflows/publish-docker-image.yml

@@ -20,13 +20,6 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
-      - name: Log in GitHub Docker registry
-        uses: docker/login-action@v1
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
       - name: Extract metadata (tags, labels) for Docker
         id: meta
         uses: docker/metadata-action@v3

.github/workflows/publish-python-package.yml

@@ -0,0 +1,43 @@
+name: Publish Python Package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish-package:
+    name: Publish Package
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set tag version
+        id: tag_version
+        run: |
+          tag=$(echo $GITHUB_REF | cut -d / -f 3)
+          echo ::set-output name=version::${tag:1}
+
+      - name: Install dependencies
+        run: python3 -m pip install setuptools wheel twine
+
+      - name: Build project
+        run: python3 setup.py sdist bdist_wheel
+
+      - name: Check build
+        run: python3 -m twine check dist/*
+
+      - name: Install leetcode-export
+        run: sudo python3 setup.py install
+
+      - name: Check that tag version matched Python package version
+        run: |
+          expected="leetcode-export ${{ steps.tag_version.outputs.version }}"
+          actual=$(leetcode-export --version)
+          echo expected=\"$expected\"
+          echo actual=\"$actual\"
+          [[ $expected == $actual ]]
+
+      - name: Publish project
+        run: python3 -m twine upload dist/* -u ${{ secrets.PYPY_USERNAME }} -p ${{ secrets.PYPY_PASSWORD }} --non-interactive

README.md

@@ -95,22 +95,24 @@ python leetcode-export --cookies {COOKIES}
 The script accepts the following arguments:
 
 ```
-usage: leetcode-export [-h] [--cookies COOKIES] [--folder FOLDER] [-v] [-vv]
+usage: leetcode-export [-h] [--cookies COOKIES] [--folder FOLDER]
                        [--problem-filename PROBLEM_FILENAME]
-                       [--submission-filename SUBMISSION_FILENAME]
+                       [--submission-filename SUBMISSION_FILENAME] [-v] [-vv]
+                       [-V]
 
 Export LeetCode solutions
 
 optional arguments:
   -h, --help            show this help message and exit
-  --cookies COOKIES     Set LeetCode cookies
-  --folder FOLDER       Output folder
-  -v, --verbose         Enable verbose logging details
-  -vv, --extra-verbose  Enable more verbose logging details
+  --cookies COOKIES     set LeetCode cookies
+  --folder FOLDER       set output folder
   --problem-filename PROBLEM_FILENAME
-                        Problem description filename format
+                        problem description filename format
   --submission-filename SUBMISSION_FILENAME
-                        Submission filename format
+                        submission filename format
+  -v, --verbose         enable verbose logging details
+  -vv, --extra-verbose  enable more verbose logging details
+  -V, --version         show program's version number and exit
 ```
 
 Using the interactive menu is preferred as it will avoid storing your cookies in the command history.

leetcode_export/__main__.py

@@ -1,10 +1,10 @@
-#!/usr/bin/env python3
 import argparse
 import logging
 import os
 from string import Template
 from typing import Set
 
+from leetcode_export._version import __version__
 from leetcode_export.leetcode import LeetCode
 
 PROBLEM_CONTENT_TEMPLATE = Template('''${question_id} - ${title}
@@ -16,16 +16,18 @@
 
 def parse_args():
     parser = argparse.ArgumentParser(description='Export LeetCode solutions')
-    parser.add_argument('--cookies', type=str, help='Set LeetCode cookies')
-    parser.add_argument('--folder', type=str, default='.', help='Output folder')
-    parser.add_argument('-v', '--verbose', dest='verbose', action='store_true', help='Enable verbose logging details')
-    parser.add_argument('-vv', '--extra-verbose', dest='extra_verbose', action='store_true',
-                        help='Enable more verbose logging details')
+    parser.add_argument('--cookies', type=str, help='set LeetCode cookies')
+    parser.add_argument('--folder', type=str, default='.', help='set output folder')
     parser.add_argument('--problem-filename', type=str, default='${question_id} - ${title_slug}.txt',
-                        help='Problem description filename format')
+                        help='problem description filename format')
     parser.add_argument('--submission-filename', type=str,
                         default='${date_formatted} - ${status_display} - runtime ${runtime} - memory ${memory}.${extension}',
-                        help='Submission filename format')
+                        help='submission filename format')
+    parser.add_argument('-v', '--verbose', dest='verbose', action='store_true', help='enable verbose logging details')
+    parser.add_argument('-vv', '--extra-verbose', dest='extra_verbose', action='store_true',
+                        help='enable more verbose logging details')
+    parser.add_argument('-V', '--version', action='version',
+                        version='%(prog)s {version}'.format(version=__version__))
     parser.set_defaults(verbose=False, extra_verbose=False)
 
     return parser.parse_args()

leetcode_export/_version.py

@@ -0,0 +1 @@
+__version__ = '1.1.1'

setup.py

@@ -1,14 +1,17 @@
 from setuptools import setup, find_packages
 
+exec(open('leetcode_export/_version.py').read())
+
 with open("README.md", 'r') as f:
     long_description = f.read()
 
 setup(
     name='leetcode-export',
-    version='1.1.1',
+    version=__version__,
     url='https://github.com/NeverMendel/leetcode-export',
     license='MIT',
     author='Davide Cazzin',
+    email='cazzindavide@gmail.com',
     description='Python script to export your LeetCode solutions',
     long_description=long_description,
     long_description_content_type='text/markdown',