研究室10

導入
DPSオープンソースプロジェクトコースのLab 10については、学期末に行われている静的サイトジェネレータの公式リリースを行う予定です.

リリース
静的サイトジェネレータlink ) 基本的にリリースの準備ができました.または、私は考えました.
私はリリースのツールとパッケージを選択すると、私の冒険を始めた.私は続けたthese 私の静的サイト・ジェネレータを包装して、リリースするプロセスを始めるために、ステップ.
一般的に、手順は非常に簡単に従うことでした、私は時間がないのバージョン1.0.0を得ることができた.ここにリンクV1.0.0 .
コマンドを実行し、パッケージをインストールした後、私は大きな問題に出くわしました.私は呼び出しに主な機能がありませんでした.そして、それはどんなユーザーのためにでもユーザビリティ問題のヒープを導入します.それで、私は私が新しいリリースをする前に、私の静的サイトジェネレータがいくつかの修正を必要とすると決めました.

私の問題

問題1
私が直面した最初の問題は、私の静的サイトジェネレータがコールする公式の主な機能がなかったという事実でした.はい、__main__ しかし、それは単にユーザを呼ぶ代わりに、ユーザーが呼ぶのが面倒ですmain 関数.

問題2
引数の解析は私のツールのために非常に特異的でした.私は私の引数の構文解析を再利用したかったので、ユーザはどんな命令でもどんなコマンドでも入力することができます、そして、プログラムはまだ正しく機能します.

問題3
最後の問題は、私のコードをリファクタリングし、フォルダー構造でそれを整理した.私は静的サイトジェネレータのメインフォルダでは、私はテストファイル、メインのロジックファイルやその他のファイルを持って気づいた.これは、私の倉庫に悪夢を働くプロセスを作ります.

修正
私のプログラムは多くの変更を受けました.

問題1修正
問題1に対する救済策はここにありますcommit . 今、私は静的サイトジェネレータパッケージのユーザーが利用できる適切な主な機能を持つことができました.

問題2修正
問題2に対する救済策はこちらcommit . ご覧のように、Pythonで利用できるArgParserライブラリを使用して引数を解析する新しい方法を導入しました.なんと安らか!

問題3修正
この問題に対する救済策はいくつかのコミットを取った.

Commit 1

Commit 2

Commit 3

Commit 4

あまりにも多くのコミットがあった理由は、リファクタリングによって新しいフォルダを導入したためです.これは私の統合テストの多くを破りました.そして私はWindowsマシン上にあるので、私はGithubに変更をプッシュするときだけLinuxの問題に対処することができました.

ユーザテスト
ユーザーテストは、サイドユーザーに沿って行われましたa-rokay , 誰がテストスクリプトで私のパッケージを使おうとしてもよかったです.Ahmadのフィードバックは非常に肯定的であり、推奨された唯一の変更は私のREADMEにわずかな変更だった.mdファイル.
フィードバックのスクリーンショットはこちら


私のSSGを使う方法
私の静的サイトジェネレータを使用する指示は、私のもので見つかりましたREADME .
このReadMeは私のSSGパッケージをあなた自身のスクリプトで稼働させるために必要なすべての指示を概説します.
要約するには、次のコマンドを実行する必要があります.

pip install staticsg-rrezinkin

これは静的サイトジェネレータをあなたのライブラリーにインストールします、そして、現在、あなたはあなた自身のプロジェクトでそれを簡単に利用することができます.
静的サイトジェネレータを利用するには

from staticsg import romanssg

romanssg.main(sys.argv[1:])

ご覧のように、Pythonファイルにインポートする必要があります.主な関数、引数を渡します.引数のリストはここにあります.Command List