pygorithms

Pygorithms

Pythonで書かれたアルゴリズム。このリポジトリには、ソートから検索まで、CSクラスで学習した一般的なアルゴリズムが含まれています。

はじめる

プロジェクトはまだ十分に小さいため、リポジトリをクローンして、リポジトリのルートディレクトリ内のPythonファイルにコードを記述するだけです。たとえば、ソートフォルダーからマージソートアルゴリズムを使用する場合は、リポジトリのルートディレクトリにPythonファイルを作成できます。

merge_sort_example.py

 from sorting.merge_sort import MergeSort

unsorted_list = [5, 3, 4, 1, 2]
sorted_list = MergeSort.sort(unsorted_list)

print("Unsorted: " + str(unsorted_list))
print("Sorted: " + str(sorted_list))

貢献

貢献したい場合は、コピーをフォークして始めましょう。ただし、貢献する前にやるべきことがいくつかあります。

pytest

このプロジェクトでは、多くのPytestモジュールとGIT事前コミットフックを使用して、コミットが行われる前にバグがキャッチされるようにします。マシンにpytestをインストールする必要があります。

ピコデスタイル

このプロジェクトは、Pycodesyleのコードスタイルガイドラインに従います。マシンにPycodesyleをインストールする必要があります。

検証します

VALIDATEと呼ばれる実行可能ファイルは、このレポのルートディレクトリにあります。コードの変更がpytestとpycodestyleを通過することを確認するために、この実行可能ファイルを実行してすべてのコードを確認できます。

Gitフックをセットアップします

前述のように、コミットが受け入れられる前に、すべてのコードパスPytestとPycodestyleを検証するために、コミット前のフックを使用します。基本的に、このフックはあなたのために検証済みの実行可能ファイルを実行し、検証がエラーメッセージで戻ってきた場合にコミットを拒否します。

このgitフックをセットアップするには、このレポのルートディレクトリでセットアップ実行可能ファイルを実行するだけで、コミットが行われる前にpytestとpycodestyleに対するコードを自動的に検証するファイルを作成します。