Merge pull request #15 from eggplants/improve

Improve codebase

Author: eggplants

.github/workflows/publish.yaml

@@ -0,0 +1,30 @@
+name: Release Package
+
+# need to setup:
+# secrets.PYPI_API_TOKEN (See: https://pypi.org/help/#apitoken)
+# secrets.TESTPYPI_API_TOKEN (See: https://test.pypi.org/help/#apitoken)
+
+on:
+  # TODO: enable scheduled run
+  # schedule:
+  # - cron: 0 0 * * *
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install poetry
+      run: pipx install poetry
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+        cache: poetry
+    - name: Setup Poetry to publish
+      run: |
+        poetry install --no-interaction
+        poetry config pypi-token.testpypi '${{ secrets.TESTPYPI_API_TOKEN }}'
+        poetry config pypi-token.pypi '${{ secrets.PYPI_API_TOKEN }}'
+    - name: Publish package
+      run: python publish.py

.pre-commit-config.yaml

@@ -0,0 +1,51 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.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.14.0
+  hooks:
+  - id: pretty-format-yaml
+    args: [--autofix, --indent, '2']
+- repo: https://github.com/tox-dev/pyproject-fmt
+  rev: v2.5.0
+  hooks:
+  - id: pyproject-fmt
+- repo: https://github.com/psf/black
+  rev: 24.10.0
+  hooks:
+  - id: black
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.8.1
+  hooks:
+  - id: ruff
+    args: [--fix]
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.13.0
+  hooks:
+  - id: mypy
+    files: ^openapi_generator_cli/
+    args: [--strict]
+    # additional_dependencies:
+- repo: https://github.com/igorshubovych/markdownlint-cli
+  rev: v0.43.0
+  hooks:
+  - id: markdownlint
+    exclude: ^.github/PULL_REQUEST_TEMPLATE.md
+    args: [--disable=MD013]

.travis.yml

@@ -1,19 +1,29 @@
 # OpenApi Generator PIP Package Generator
 
-[![Join the Slack chat room](https://img.shields.io/badge/Slack-Join%20the%20chat%20room-orange)](https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g)
-<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
-
-OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and 
-configuration automatically given an OpenAPI Spec (both 2.0 and 3.0 are supported). Please see
-[OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator)
+[![Join the Slack chat room](
+  <https://img.shields.io/badge/Slack-Join%20the%20chat%20room-orange>
+)](
+  <https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g>
+) [![Code style: black](
+  <https://img.shields.io/badge/code%20style-black-000000.svg>
+)](
+  <https://github.com/psf/black>
+) [![Ruff](
+  <https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json>
+)](
+  <https://github.com/astral-sh/ruff>
+)
+
+OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (both 2.0 and 3.0 are supported). Please see [OpenAPITools/openapi-generator]
 
 ---
 
-This project checks the [maven repository](https://mvnrepository.com/artifact/org.openapitools/openapi-generator-cli) 
-once a day for a new version and will publish this new version automatically as a python package.
+This project checks the [maven repository] once a day for a new version and will publish this new version automatically as a python package.
 
 ## Installation
 
+You must have the `java` binary executable available on your PATH for this to work. (JDK 11 is the minimal version supported. To install OpenJDK, please visit <https://adoptium.net/>)
+
 You can install the package either in a virtual environment or globally.
 
 ```sh
@@ -24,20 +34,18 @@ pip install openapi-generator-cli
 pip install openapi-generator-cli==4.3.1
 ```
 
-After installation `openapi-generator` command will be available in your virtual environment or globally 
-depending on your installation
+After installation `openapi-generator-cli` command will be available in your virtual environment or globally depending on your installation.
 
 To check the version, for example. Type the following command
 
 ```sh
 # this will print the correct version number
-openapi-generator version
+openapi-generator-cli version
 ```
 
 ## Further Documentation
 
-Please refer to the [official openapi-generator docs](https://github.com/OpenAPITools/openapi-generator#3---usage) for
-more information about the possible arguments and a detailed usage manual of the command line interface.
+Please refer to the [official openapi-generator docs] for more information about the possible arguments and a detailed usage manual of the command line interface.
 
 ## Like the package?
 
@@ -46,3 +54,7 @@ Please leave a star.
 ## Have suggestions or feedback?
 
 Please raise an issue, happy to hear from you :)
+
+[OpenAPITools/openapi-generator]: <https://github.com/OpenAPITools/openapi-generator>
+[maven repository]: <https://mvnrepository.com/artifact/org.openapitools/openapi-generator-cli>
+[official openapi-generator docs]: <https://github.com/OpenAPITools/openapi-generator#3---usage>

LICENSE

@@ -1,30 +1,30 @@
-# coding=utf-8
-# !/usr/bin/env python
+from __future__ import annotations
+
+import importlib.resources
 import os
 import subprocess
 import sys
 
 
-def run(args=None):
+def run(args: list[str] | None = None) -> None:
     arguments = ["java"]
 
-    if os.getenv("JAVA_OPTS"):
-        arguments.append(os.getenv("JAVA_OPTS"))
+    java_opts = os.getenv("JAVA_OPTS")
+    if java_opts:
+        arguments.append(java_opts)
 
     arguments.append("-jar")
 
-    jar_path = os.path.join(
-        os.path.dirname(os.path.realpath(__file__)), "openapi-generator.jar"
-    )
-    arguments.append(jar_path)
+    jar_path = importlib.resources.files("openapi_generator_cli") / "openapi-generator.jar"
+    arguments.append(str(jar_path))
 
     if args and type(args) == list:
         arguments.extend(args)
 
-    subprocess.call(" ".join(arguments), shell=True)
+    subprocess.call(arguments)  # noqa: S603
 
 
-def cli():
+def cli() -> None:
     args = []
     if len(sys.argv) > 1:
         args = sys.argv[1:]