Skip to content

SourceSage 4.1.0 リリースノート
Compare
Choose a tag to compare
@Sunwood-ai-labs Sunwood-ai-labs released this 07 Apr 15:47
· 65 commits to main since this release
undefined4.1.1
4a881e4

概要

SourceSage 4.1.0では、以下の主要な機能追加と改善が行われました。

  • プロジェクト全体の出力ファイル名と各モジュールの出力フォルダ名の変更
  • PyPIのダウンロードバッジとCodacyのクオリティバッジの追加
  • setup.pyの更新とバージョンアップ
  • アスキーアートの追加によるソースコードの視認性向上
  • CLI引数の追加とコアモジュールの修正
  • プロジェクトの構成とファイルの変更によるシンプル化
  • テストドキュメントの改善とわかりやすい説明の追加
  • テストコードの修正とセットアップスクリプトの更新
  • README.mdの見出しとビジュアル要素の追加による可読性の向上
  • セットアップ手順、実行方法、クイックスタートセクションの更新

変更の詳細

プロジェクト全体の出力ファイル名と各モジュールの出力フォルダ名の変更

  • プロジェクト全体の出力ファイル名を "SourceSage" から "DocuMind" に変更
  • 関連するディレクトリ名とファイル名を新しいプロジェクト全体の出力ファイル名に合わせて更新
  • setup.pyのバージョン番号を '4.0.11' から '4.0.12' に更新
  • constants.pyの値を更新し、新しい名称に対応

PyPIのダウンロードバッジとCodacyのクオリティバッジの追加

  • README.mdにPyPIの日次ダウンロード数と週次ダウンロード数のバッジを追加
  • README.mdにCodacyのクオリティバッジを追加
  • README.mdにこのリポジトリ自体がSourceSageを活用していることを明記
  • setup.pyのバージョンを4.0.10から4.0.11に更新
  • setup.pyにclassifiersを追加し、プロジェクトの状態や対象ユーザー、トピックを明示

setup.pyの更新とバージョンアップ

  • setup.pyのバージョン番号を4.0.5から4.0.9へ変更
  • パッケージデータの指定方法を修正し、サブディレクトリ以下のファイルも含めるように変更
  • 依存ライブラリにartを追加

アスキーアートの追加によるソースコードの視認性向上

  • artライブラリをインポート
  • SourceSageクラスのrunメソッドの先頭で、tprint関数を使用して"SourceSage"のアスキーアートロゴを表示するように変更

CLI引数の追加とコアモジュールの修正

  • sourcesage/cli.pyとsourcesage/core.pyに新しいCLI引数--ignore-fileと--language-mapを追加
    • デフォルト値はパッケージ内の設定ファイルを使用するように修正
  • SourceSageクラスのコンストラクタにignore_fileとlanguage_map_fileの引数を追加
  • SourceSageModuleとStagedDiffGeneratorの初期化時に、追加した引数を渡すように修正
  • tests/test_sourcesage.pyのテストケースを修正し、CLI引数を追加

プロジェクトの構成とファイルの変更によるシンプル化

  • 不要なファイルやフォルダを削除
    • .env.exampleファイル
    • SourceSage.pyファイル
    • docs/HTML/timeline_sample.mdファイル
    • docs/css/style.cssファイル
  • .SourceSageignoreファイルを更新し、必要なフォルダや一時ファイルが除外対象になるように設定

テストドキュメントの改善とわかりやすい説明の追加

  • テストコマンドの説明を「テストの実行」という見出しに変更し、ユニットテストの実行方法を詳しく説明
  • 本番環境でのテストについて、新しい章を追加し、sourcesageコマンドの使用方法を説明
  • リポジトリの指定について、新しい章を追加し、オーナー名とリポジトリ名の指定方法を説明
  • コマンドのフォーマットをマークダウンのコードブロックで囲み、視覚的に分かりやすく改善
  • 各章の説明文を追加し、内容をより明確化

テストコードの修正とセットアップスクリプトの更新

  • テストコードの修正:
    • test_sourcesage_cli 関数内の sys.argv に --owner と --repository の引数を追加
    • test_sourcesage_core 関数内の SourceSage クラスのインスタンス化時に、owner と repository の引数を追加
    • テストコードが指定されたコマンド sourcesage --owner Sunwood-ai-labs --repository SourceSage に対応するように変更
  • セットアップスクリプトの更新:
    • setup.py ファイルに package_data の設定を追加し、sourcesage パッケージ内の config ディレクトリ以下のファイルがパッケージに含まれるように変更
  • .gitignore ファイルに temp/ ディレクトリを追加し、テスト実行時に生成される一時ディレクトリをGitの管理対象から除外

README.mdの見出しとビジュアル要素の追加による可読性の向上

  • プロジェクトの標語「～Transforming code for AI～」を中央揃えの見出しに変更し、周囲に余白を追加
  • PyPIでの最新バージョンを示すバッジを挿入し、現在のバージョンを確認しやすく改善
  • 不要な空白行を削除してドキュメントを整理し、情報の密度を高める
  • PyPIのバージョンバッジを追加し、最新パッケージバージョンを一目で識別できるように改善

セットアップ手順、実行方法、クイックスタートセクションの更新

  • セットアップ手順の追加: SourceSageのインストールに必要な手順を追加し、pipを使用したインストール方法を明記
  • クイックスタートガイドの導入: 新たにクイックスタートセクションを設け、SourceSageの基本的な使用方法についての手順を追加
    • プロジェクトディレクトリへの移動からSourceSageの実行、生成されるファイルの説明までをステップバイステップで説明
  • リポジトリのIssue取得方法に関する説明の改善: GitHubのリポジトリIssueを取得する方法の説明を更新し、リポジトリのオーナー名とリポジトリ名をコマンドライン引数で指定する方法を詳述

まとめ

SourceSage 4.1.0では、プロジェクトの構成や出力ファイル名の変更、各種バッジの追加、セットアップ手順やクイックスタートガイドの充実化など、ユーザビリティと視認性の向上に重点を置いた改善が行われました。また、テストコードの修正やドキュメントの改善により、開発者にとってもより使いやすく、メンテナンスしやすいプロジェクトになりました。

今後もSourceSageは、ユーザーと開発者双方のフィードバックを取り入れながら、継続的な改善と機能追加を行っていきます。ご期待ください！

Assets 2