Harmon-ai


新機能

- **Gaiah設定ファイルの追加**: Gaiah設定ファイル(.gaiah/config.yml)が追加され、Gaiahの動作を設定できるようになりました。
- **READMEの自動置換機能**: 生成されたREADMEをメインディレクトリのREADME.mdに自動的に置換する機能が追加されました。

変更点

- **YAMLによる設定ファイル管理**: 設定ファイルがYAML形式(.harmon_ai/config.yml)になり、より柔軟な設定が可能になりました。
- **CI/CDファイルの自動コピー**: CICDファイル(.harmon_ai/publish-to-pypi.yml)が自動的にコピーされ、プロジェクトへの組み込みが容易になりました。
- **設定ファイルの構造変更**: 設定ファイルの構造が変更され、より整理された階層構造になりました。

その他

- 内部的なリファクタリングとコードのクリーンアップが行われました。

修正点

- いくつかのバグが修正されました。

**詳細な変更点については、コミット履歴をご確認ください。**



HarmonAI IIの新バージョン1.4.0をリリースしました！
このバージョンでは、ユーザビリティとカスタマイズ性を大幅に向上させました。以下に主な変更点をご紹介します。

🎉 主な新機能

1. YAMLによる設定ファイル管理 🛠️
- プロジェクトの設定をYAML形式の設定ファイル(`config.yml`)で一元管理できるようになりました。
- 設定ファイルのテンプレートが自動生成され、必要な設定を簡単にカスタマイズできます。

2. ログ出力の改善 📝
- `loguru`ライブラリを導入し、より詳細で見やすいログ出力を実現しました。
- ログレベルに応じた色分けにより、重要な情報を見落とすことなく確認できます。

3. CI/CDファイルの自動コピー 🚀
- プロジェクトで使用するCI/CDファイル(`publish-to-pypi.yml`)を自動的にコピーします。
- 開発用ディレクトリと本番用ディレクトリの両方にCI/CDファイルが配置され、シームレスなデプロイが可能です。

🔧 その他の改善点

- `harmon_ai.py`の構造を改善し、コードの可読性と保守性を向上しました。
- `utils.py`を新たに追加し、ユーティリティ関数を集約しました。
- `important_template.md`のデフォルトメッセージを更新し、HarmonAI IIプロジェクトの特徴をより明確に伝えるようにしました。

🐛 バグ修正

- 特筆すべきバグ修正はありません。

📦 依存関係の変更

- `pyyaml`と`loguru`を新たに依存関係に追加しました。

より詳細な変更点については、[Git Diff レポート](https://github.com/Sunwood-ai-labs/HarmonAI_II/compare/v1.3.0...v1.4.0)をご覧ください。

HarmonAI IIチームは、皆様からのフィードバックを心よりお待ちしております。バグ報告や機能リクエストなどがございましたら、Issueを作成していただくか、プルリクエストをお送りください。

これからもHarmonAI IIをよろしくお願いいたします！ 🙏✨



新機能

- **SNSテンプレートの追加とSNSバッジ生成**: プロジェクトのWebサイト、GitHub、Twitter、ブログなどのソーシャルメディアチャンネルにリンクするための新しいマークダウンテンプレートファイル（ `sns _template.md `）を導入し、`HarmonAI`クラス内でソーシャルメディアバッジを生成する機能を追加しました。これにより、READMEファイル内にSNSリンクを動的に挿入し、READMEテンプレートにSNSバッジを直接表示するための新しいセクションを追加しました。

改良と改善

- **CLIの強化とREADMEの更新**: コマンドラインインターフェースを強化し、引数にデフォルト値と明示性を追加しました。また、カラー出力とASCIIアートによってユーザーエクスペリエンスを向上させました。プロジェクトのドキュメントをREADME.mdで更新し、新しいコマンドラインオプションを追加しました。

- **GitHub Actionsトリガーの更新**: GitHub Actionsワークフローを変更し、mainブランチへのプッシュ時にのみトリガーされるようにしました。これにより、デプロイプロセスが合理化され、管理が容易になりました。

- **setup.pyにプロジェクトリンクを追加**: 公式のGitHubリポジトリURLを`setup.py`ファイルに追加し、パッケージのメタデータからリポジトリにアクセスしやすくしました。

リファクタリングとコードのクリーンアップ

- **ファイル処理におけるエンコーディングの明示化**: `HarmonAI`ライブラリでファイルエンコーディングを明示的に`utf8`と定義するようにリファクタリングし、異なる環境間でのエンコーディングの問題を防止しました。

- **CLIの引数処理の改善**: `harmon_ai/cli.py`でCLIパラメータを必須に再定義し、新しいSNS関連のオプションを追加しました。これにより、ユーザーは必要な情報を明示的に提供する必要があります。

- **インポートのクリーンアップ**: `harmon_ai/__init__.py`で不要なインポートをコメントアウトし、コードの可読性を向上させました。

ドキュメント

- **SNSリンクのドキュメント化**: プロジェクトのREADMEドキュメントに、新しいSNSバッジ機能とその使用方法に関する説明を追加しました。

変更履歴の各エントリは、変更内容を詳しく理解できるように、特定のコミットに紐付けられています。これらの更新は、ユーザーと開発者の両方のエクスペリエンスを向上させ、プロジェクトの効率性とアクセシビリティを確保することを目的としています。


🌟 新機能

harmon_aiパッケージの刷新

- `harmon_ai`パッケージの初期設定を行い、`harmon_ai`クラスをimportできるようにしました。
- `harmon_ai`クラスに、README生成メソッド`generate_readme`とバッジ生成メソッド`generate_badges`を実装しました。
- テンプレートファイルを読み込み、リポジトリ情報で置換することで、カスタマイズ可能なREADMEファイルを生成できるようになりました。

コマンドラインインターフェース(CLI)の導入

- `argparse`を使用してCLIオプションを定義し、コマンドラインからREADMEファイルを生成できるようにしました。
- 生成されたREADMEファイルを指定のディレクトリに出力する機能を追加しました。

📝 ドキュメントの改善

READMEテンプレートファイルの拡充

- バッジのマークダウンテンプレート(`badges_template.md`)を追加しました。
- 重要メッセージのテンプレート(`important_template.md`)を追加しました。
- READMEの全体的な構造のテンプレート(`readme_template.md`)を追加しました。
- READMEの各セクションのテンプレート(`sections_template.md`)を追加しました。

✅ テストの強化

`harmon_ai`クラスのテストケースを実装

- `generate_badges`関数のテストケースを追加しました。
- `generate_readme`関数のテストケースを追加しました。
- テンプレートの読み込みと期待される出力の検証を行いました。

🔧 セットアップとデプロイの改善

パッケージのセットアップ設定の更新

- `find_packages`を使用してパッケージを自動検出するようにしました。
- エントリーポイントに`harmon-ai`コマンドを設定しました。
- パッケージの基本情報やPythonバージョンの互換性を定義しました。

PyPIへのパッケージ公開ワークフローの追加

- タグプッシュをトリガーにパッケージをビルドしてPyPIに公開するワークフローを追加しました。
- Pythonのバージョンを設定し、パッケージの依存関係のインストールとビルドを行います。
- PyPIへのパッケージ公開アクションを設定しました。

🙌 コントリビューターの皆様へ

今回のリリースにご協力いただいたコントリビューターの皆様に感謝いたします。皆様のサポートにより、HarmonAI IIプロジェクトは大きく前進することができました。引き続き、プロジェクトへのご支援とご協力をよろしくお願いいたします。

🔗 関連リンク

- [HarmonAI II GitHub リポジトリ](https://github.com/HarmonAI_II/Sunwood-ai-labs)
- [HarmonAI II PyPI パッケージ](https://pypi.org/project/harmon-ai/)

HarmonAI IIプロジェクトをよろしくお願いいたします！🚀✨

主な更新内容

- フロントページの作成
- `app.py`にフロントページの表示機能を追加
- `load_markdown`関数を定義し、Markdownファイルを読み込む
- `display_front_page`関数を定義し、`docs/page_front.md`を読み込んで表示する
- `docs/page_front.md`を新規作成し、プロジェクトのタイトル、アイコン、説明文を記述
- GitHubのレポジトリ情報を表示するバッジを追加

- READMEの全体的な改善
- プロジェクトの概要と目的を明確に説明
- デモアプリケーションについての情報を追加
- インストールと使用方法のセクションを充実
- カスタマイズ可能性についての説明を追加
- 更新履歴のセクションを改善し、主要な更新内容を箇条書きで列挙
- コントリビューションについての説明を拡充し、関連ドキュメントへのリンクを追加
- ライセンス情報を明示
- 謝辞のセクションを追加し、関連するプロジェクトやチームに言及
- 全体的な文章の流れとフォーマットを改善

その他の変更点

- GitHub Actionsを使用したHuggingFace hubへの自動シンク機能の追加
- .gitignoreと.SourceSageignoreの更新による不要なファイルの除外
- プロジェクト名を「HarmonAI」から「HarmonAI_II」に変更

バグ修正

- なし

既知の問題

- なし

今後の予定

- 新機能の追加
- パフォーマンスの最適化
- ドキュメンテーションの拡充

HarmonAI IIプロジェクトをご利用いただきありがとうございます。引き続きのご支援をよろしくお願いいたします。