1. ホーム /
  2. Works /
  3. [Tools] バッチ設計書から、テンプレートソースコードを作成するツールを公開しました。
Works

[Tools] バッチ設計書から、テンプレートソースコードを作成するツールを公開しました。

  • 2023.02.24
  • by ShinyaTomozumi
  • 0

公開GitHub

Dark Mode

document-to-batch (this link opens in a new window) by ShinyaTomozumi (this link opens in a new window)

Create template source code for the batch from the batch design document.

1 Subscriber 0 Watchers 0 Forks Check out this repository on GitHub.com (this link opens in a new window)

ツール概要

システム開発でバッチ処理を実装することがあります。
大きなプロジェクトで、バッチの設計書や仕様書を作成しておくことで引き継ぎなども楽に行うことができます。
以前関わったプロジェクトで、大量のバッチを作成しましたが最初のファイル作成の着手だけでも大変ですので、設計書からバッチの雛形を作成するツールを作成しました。
バッチの説明に処理の概要などを記載しておけば、テンプレートソースコードにその内容を記載するようにして、開発者はそのままソースコードに開発することができます。

開発環境

本ツールは以下のプログラムで作成しております。

  • Python 3.9

またエクセルファイルを読み込むために、以下のライブラリをインストールする必要があります。

$ pip install openpyxl

使い方

まずは上記のGitHubからソースコードをクローンします。
ソースコード内にある「_sample/SampleBatchCommand.xlsx」に、バッチ処理を追記します。
項目はヘッダー部分に記載しておりますので、それを元に記載してください。

実行コマンド

$ python document_to_views.py -t [プロジェクトの種類] -i [読み込むドキュメントのパス]

コマンドで使用するオプションは、以下の通りとなります。

KeyDescription
-t必須。
書き出すソースコードの、プロジェクトの種類を設定します。
現在対応するプロジェクトは、以下の通りです。
– laravel
-i必須。
読み込むドキュメントのパスを設定します。
-o任意。
描き出すソースコードのパスを指定します。
デフォルトは「output_batches_****」という具合になります。
-doc任意。
設計書の種類を定義します。
現在対応する設計書の種類は、以下の通りです。
– excel
未設定時は「excel」となります。

まだ対応する種類は限られておりますが、今後もアップデートして様々なドキュメントやプロジェクトに対応する予定です。
是非とも使って頂きご意見・ご感想いただければありがたいです。
必要に応じて改修して対応する項目を増やせて頂ければと思います。