feat: refactoring

Author: eggplants

.github/workflows/release.yml

@@ -1,46 +1,64 @@
 name: Release Package
 
+# need to setup:
+# secrets.PYPI_PASSWORD (See: https://pypi.org/help/#apitoken)
+
 on:
   push:
     tags:
-      - '*'
+    - v*
+env:
+  PYTHON_VERSION: '3.11'
+  PROJECT_NAME: my_best_python_project
 
 jobs:
   release:
-    name: Create Release
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
-        uses: actions/checkout@master
-      - name: Create Release
-        id: create_release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ github.ref }}
-          draft: false
-          prerelease: false
+    - uses: actions/checkout@v3
+
+    - id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ github.ref }}
+        release_name: Release ${{ github.ref }}
+        draft: false
+        prerelease: false
   pypi:
     needs: release
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-        with:
-          persist-credentials: false
-      - name: Set up Python
-        uses: actions/setup-python@v1
-        with:
-          python-version: "3.x"
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install setuptools wheel twine
-      - name: Build and publish
-        env:
-          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-        run: |
-          python setup.py sdist bdist_wheel
-          twine upload dist/*
+    - uses: actions/checkout@v3
+      with:
+        persist-credentials: false
+    - name: Build and publish to pypi
+      uses: JRubics/[email protected]
+      with:
+        pypi_token: ${{ secrets.PYPI_TOKEN }}
+  ghcr:
+    needs: release
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: docker/metadata-action@v4
+      id: meta
+      with:
+        images: ghcr.io/${{ github.repository }}
+        tags: |
+          type=semver,pattern={{version}}
+          type=semver,pattern={{major}}.{{minor}}
+    - uses: docker/login-action@v2
+      with:
+        registry: ghcr.io
+        username: ${{ github.repository_owner }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+    - uses: docker/build-push-action@v4
+      with:
+        context: .
+        push: true
+        tags: ${{ steps.meta.outputs.tags }}
+        labels: ${{ steps.meta.outputs.labels }}
+        build-args: |
+          VERSION=${{ github.event.release.tag_name }}

.pre-commit-config.yaml

@@ -0,0 +1,54 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: check-added-large-files
+    args: [--maxkb=2000]
+  - id: check-ast
+  - id: check-case-conflict
+  - id: check-executables-have-shebangs
+  - id: check-merge-conflict
+  - id: check-symlinks
+  - id: check-toml
+  - id: check-yaml
+  - id: debug-statements
+  - id: destroyed-symlinks
+  - id: end-of-file-fixer
+    files: \.(py|sh|rst|yml|yaml)$
+  - id: mixed-line-ending
+  - id: trailing-whitespace
+    files: \.(py|sh|rst|yml|yaml)$
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+  rev: v2.7.0
+  hooks:
+  - id: pretty-format-yaml
+    args: [--autofix, --indent, '2']
+- repo: https://github.com/tox-dev/pyproject-fmt
+  rev: 0.9.1
+  hooks:
+  - id: pyproject-fmt
+- repo: https://github.com/psf/black
+  rev: 23.1.0
+  hooks:
+  - id: black
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  rev: v0.0.248
+  hooks:
+  - id: ruff
+    args: [--fix]
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.0.1
+  hooks:
+  - id: mypy
+    files: ^shindan_cli/
+    args: [--strict]
+    additional_dependencies:
+    - types-beautifulsoup4
+    - types-requests
+    - lxml-stubs
+- repo: https://github.com/igorshubovych/markdownlint-cli
+  rev: v0.33.0
+  hooks:
+  - id: markdownlint
+    exclude: ^.github/PULL_REQUEST_TEMPLATE.md
+    args: [--disable=MD013]

Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3
+
+ARG VERSION
+ENV VERSION ${VERSION:-master}
+
+RUN pip install --upgrade pip
+
+RUN python -m pip install git+https://github.com/eggplants/shindan_cli@${VERSION}
+
+ENTRYPOINT ["shindan"]

poetry.lock

@@ -1,3 +1,74 @@
+# poetry self add poetry-bumpversion
+
 [build-system]
-requires = ["wheel", "setuptools"]
-build-backend = "setuptools.build_meta"
+build-backend = "poetry.core.masonry.api"
+requires = [
+  "poetry-core",
+]
+
+[tool]
+[tool.black]
+line-length = 120
+target-version = ['py39']
+
+[tool.isort]
+profile = "black"
+
+[tool.mypy]
+pretty = true
+python_version = "3.9"
+show_error_codes = true
+strict = true
+
+[tool.ruff]
+select = ["ALL"]
+ignore = ["D211", "D213"]
+line-length = 120
+
+[tool.ruff.mccabe]
+max-complexity = 18
+
+[tool.poetry]
+authors = ["eggplants <[email protected]>"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.7",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3 :: Only"
+]
+description = "ShindanMaker (https://shindanmaker.com) CLI"
+keywords = ["shindanmaker", "cli"]
+name = "shindan_cli"
+packages = [{include = "shindan_cli"}]
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/eggplants/shindan-cli"
+version = "0.9.0"
+
+[tool.poetry.dependencies]
+python = ">=3.7,<4"
+beautifulsoup4 = "^4.11.2"
+lxml = "^4.9.2"
+requests = "^2.28.2"
+
+
+[tool.poetry.group.dev.dependencies]
+mypy = "^0.991"
+pre-commit = "^2.20.0"
+taskipy = "^1.10.3"
+types-beautifulsoup4 = "^4.11.6.7"
+types-requests = "^2.28.11.14"
+lxml-stubs = "^0.4.0"
+
+[tool.poetry.scripts]
+mbpp = "shindan_cli.main:main"
+
+[tool.poetry_bumpversion.file."shindan_cli/__init__.py"]
+
+[tool.taskipy.tasks]
+lint = "pre-commit run -a"
+profile = "python -m cProfile"

pyproject.toml

@@ -1,4 +1,7 @@
-from .shindan import shindan
+"""Initialize shindan-cli package."""
+from __future__ import annotations
 
-__version__ = "0.9"
-__all__ = ["shindan"]
+from .shindan import ShindanResult, shindan
+
+__version__ = "0.9.0"
+__all__ = ("shindan", "ShindanResult")

setup.cfg

@@ -1,47 +1,42 @@
+"""Implements Shindan CLI as a main script."""
+
+from __future__ import annotations
+
 import argparse
 
 from . import __version__, shindan
 
 
-def check_natural(v: str) -> int:
+def _check_natural(v: str) -> int:
     if int(v) < 0:
         raise argparse.ArgumentTypeError("%s is an invalid natural int" % v)
-    else:
-        return int(v)
+    return int(v)
 
 
-def parse_args() -> argparse.Namespace:
-    """Parse arguments."""
+def _parse_args() -> argparse.Namespace:
     parser = argparse.ArgumentParser(
         prog="shindan",
         formatter_class=argparse.RawDescriptionHelpFormatter,
         description="ShindanMaker (https://shindanmaker.com) CLI",
     )
-    parser.add_argument(
-        "page_id", metavar="ID", type=check_natural, help="shindan page id"
-    )
+    parser.add_argument("page_id", metavar="ID", type=_check_natural, help="shindan page id")
     parser.add_argument("shindan_name", metavar="NAME", type=str, help="shindan name")
     parser.add_argument("-w", "--wait", action="store_true", help="insert random wait")
-    parser.add_argument(
-        "-H", "--hashtag", action="store_true", help="add hashtag `#shindanmaker`"
-    )
-    parser.add_argument(
-        "-l", "--link", action="store_true", help="add link to last of output"
-    )
-    parser.add_argument(
-        "-V", "--version", action="version", version="%(prog)s {}".format(__version__)
-    )
+    parser.add_argument("-H", "--hashtag", action="store_true", help="add hashtag `#shindanmaker`")
+    parser.add_argument("-l", "--link", action="store_true", help="add link to last of output")
+    parser.add_argument("-V", "--version", action="version", version=f"%(prog)s {__version__}")
     return parser.parse_args()
 
 
 def main() -> None:
-    args = parse_args()
+    """Run CLI."""
+    args = _parse_args()
     result = shindan(args.page_id, args.shindan_name, wait=args.wait)
-    print("\n".join(result["results"]))
+    print("\n".join(result["results"]))  # noqa: T201
     if args.hashtag:
-        print(" ".join(result["hashtags"]))
+        print(" ".join(result["hashtags"]))  # noqa: T201
     if args.link:
-        print(result["shindan_url"])
+        print(result["shindan_url"])  # noqa: T201
 
 
 if __name__ == "__main__":