🆕 [feat] harmon_aiパッケージの初期設定

- harmon_aiクラスをimportするための__init__.pyファイルを作成

.Prothiel.md

@@ -0,0 +1,251 @@
+# HarmonAI
+
+## Description
+HarmonAIは、リポジトリの名前、Githubのオーナー名、パッケージ名から、PyPIとGithubのshields.ioバッジのHTMLコードを生成し、READMEファイルのテンプレートを出力するためのPythonライブラリです。このライブラリは、パッケージとしてインポートして使用することも、コマンドラインインターフェース（CLI）から直接使用することもできます。
+
+## File Structure
+```
+- harmon_ai/
+  - __init__.py
+  - harmon_ai.py
+  - cli.py
+  - templates/
+    - __init__.py
+    - badges_template.html
+    - readme_template.md
+- tests/
+  - __init__.py
+  - test_harmon_ai.py
+- setup.py
+- README.md
+- requirements.txt
+```
+
+## Source Code
+### harmon_ai/__init__.py
+```python
+from .harmon_ai import HarmonAI
+```
+
+### harmon_ai/harmon_ai.py
+```python
+import os
+
+class HarmonAI:
+    @staticmethod
+    def generate_readme(repo_name, owner_name, package_name, icon_url, title, subtitle, important_message, sections_content):
+        with open(os.path.join(os.path.dirname(__file__), "templates", "readme_template.md"), "r") as file:
+            template = file.read()
+
+        badge_template = HarmonAI.generate_badges(repo_name, owner_name, package_name)
+
+        template = template.replace("{repo_name}", repo_name)
+        template = template.replace("{owner_name}", owner_name)
+        template = template.replace("{package_name}", package_name)
+        template = template.replace("{icon_url}", icon_url)
+        template = template.replace("{title}", title)
+        template = template.replace("{subtitle}", subtitle)
+        template = template.replace("{badges}", badge_template)
+        template = template.replace("{important_message}", important_message)
+        template = template.replace("{sections_content}", sections_content)
+
+        return template
+
+    @staticmethod
+    def generate_badges(repo_name, owner_name, package_name):
+        with open(os.path.join(os.path.dirname(__file__), "templates", "badges_template.html"), "r") as file:
+            template = file.read()
+
+        template = template.replace("{repo_name}", repo_name)
+        template = template.replace("{owner_name}", owner_name)
+        template = template.replace("{package_name}", package_name)
+
+        return template
+```
+
+### harmon_ai/cli.py
+```python
+import argparse
+from .harmon_ai import HarmonAI
+
+def main():
+    parser = argparse.ArgumentParser(description="Generate README template and badges for a GitHub repository.")
+    parser.add_argument("repo_name", help="Name of the GitHub repository")
+    parser.add_argument("owner_name", help="GitHub username of the repository owner")
+    parser.add_argument("package_name", help="Name of the package")
+    parser.add_argument("icon_url", help="URL of the icon to display in the README")
+    parser.add_argument("title", help="Title of the project")
+    parser.add_argument("subtitle", help="Subtitle of the project")
+    parser.add_argument("important_message", help="Important message to display in the README")
+    parser.add_argument("sections_content", help="Content of the README sections (introduction, demo, getting_started, updates, contributing, license, acknowledgements) in markdown format")
+
+    args = parser.parse_args()
+
+    readme_template = HarmonAI.generate_readme(
+        args.repo_name,
+        args.owner_name,
+        args.package_name,
+        args.icon_url,
+        args.title,
+        args.subtitle,
+        args.important_message,
+        args.sections_content
+    )
+
+    print(readme_template)
+
+if __name__ == "__main__":
+    main()
+```
+
+### harmon_ai/templates/__init__.py
+```python
+# Empty file
+```
+
+### harmon_ai/templates/badges_template.html
+```html
+<img alt="PyPI - Version" src="https://img.shields.io/pypi/v/{package_name}">
+<img alt="PyPI - Format" src="https://img.shields.io/pypi/format/{package_name}">
+<img alt="PyPI - Implementation" src="https://img.shields.io/pypi/implementation/{package_name}">
+<img alt="PyPI - Status" src="https://img.shields.io/pypi/status/{package_name}">
+<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dd/{package_name}">
+<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dw/{package_name}">
+<a href="https://github.com/{owner_name}/{repo_name}" title="Go to GitHub repo"><img src="https://img.shields.io/static/v1?label={repo_name}&message={owner_name}&color=blue&logo=github"></a>
+<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/{owner_name}/{repo_name}">
+<a href="https://github.com/{owner_name}/{repo_name}"><img alt="forks - {owner_name}" src="https://img.shields.io/github/forks/{repo_name}/{owner_name}?style=social"></a>
+<a href="https://github.com/{owner_name}/{repo_name}"><img alt="GitHub Last Commit" src="https://img.shields.io/github/last-commit/{owner_name}/{repo_name}"></a>
+<a href="https://github.com/{owner_name}/{repo_name}"><img alt="GitHub Top Language" src="https://img.shields.io/github/languages/top/{owner_name}/{repo_name}"></a>
+<img alt="GitHub Release" src="https://img.shields.io/github/v/release/{owner_name}/{repo_name}?color=red">
+<img alt="GitHub Tag" src="https://img.shields.io/github/v/tag/{owner_name}/{repo_name}?sort=semver&color=orange">
+<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/{owner_name}/{repo_name}/publish-to-pypi.yml">
+```
+
+### harmon_ai/templates/readme_template.md
+```markdown
+<p align="center">
+<img src="{icon_url}" width="100%">
+<br>
+<h1 align="center">{title}</h1>
+<h2 align="center">
+  {subtitle}
+
+  {badges}
+
+</h2>
+
+</p>
+
+>[!IMPORTANT]
+>{important_message}
+
+{sections_content}
+```
+
+### tests/__init__.py
+```python
+# Empty file
+```
+
+### tests/test_harmon_ai.py
+```python
+import unittest
+from harmon_ai import HarmonAI
+
+class TestHarmonAI(unittest.TestCase):
+    def test_generate_badges(self):
+        repo_name = "test-repo"
+        owner_name = "test-owner"
+        package_name = "test-package"
+        
+        with open("harmon_ai/templates/badges_template.html", "r") as file:
+            expected_output = file.read()
+
+        expected_output = expected_output.replace("{repo_name}", repo_name)
+        expected_output = expected_output.replace("{owner_name}", owner_name)
+        expected_output = expected_output.replace("{package_name}", package_name)
+        
+        result = HarmonAI.generate_badges(repo_name, owner_name, package_name)
+        self.assertEqual(result, expected_output)
+
+    def test_generate_readme(self):
+        repo_name = "test-repo"
+        owner_name = "test-owner"
+        package_name = "test-package"
+        icon_url = "https://example.com/icon.png"
+        title = "Test Title"
+        subtitle = "Test Subtitle"
+        important_message = "This is an important message."
+        
+        sections_content = '''
+    ## Introduction
+    This is the introduction.
+
+    ## Demo
+    This is the demo.
+
+    ## Getting Started
+    This is how to get started.
+
+    ## Updates
+    These are the updates.
+
+    ## Contributing
+    This is how to contribute.
+
+    ## License
+    This is the license.
+
+    ## Acknowledgements
+    These are the acknowledgements.
+'''
+        
+        with open("harmon_ai/templates/readme_template.md", "r") as file:
+            expected_output = file.read()
+
+        expected_output = expected_output.replace("{repo_name}", repo_name)
+        expected_output = expected_output.replace("{owner_name}", owner_name)
+        expected_output = expected_output.replace("{package_name}", package_name)
+        expected_output = expected_output.replace("{icon_url}", icon_url)
+        expected_output = expected_output.replace("{title}", title)
+        expected_output = expected_output.replace("{subtitle}", subtitle)
+        expected_output = expected_output.replace("{badges}", HarmonAI.generate_badges(repo_name, owner_name, package_name))
+        expected_output = expected_output.replace("{important_message}", important_message)
+        expected_output = expected_output.replace("{sections_content}", sections_content)
+        
+        result = HarmonAI.generate_readme(repo_name, owner_name, package_name, icon_url, title, subtitle, important_message, sections_content)
+        self.assertEqual(result, expected_output)
+
+if __name__ == "__main__":
+    unittest.main()
+```
+
+### setup.py
+```python
+from setuptools import setup, find_packages
+
+setup(
+    name="harmon_ai",
+    version="0.1.0",
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=[
+        # Add any dependencies here
+    ],
+    entry_points={
+        "console_scripts": [
+            "harmon-ai = harmon_ai.cli:main"
+        ]
+    },
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+    ],
+)
+```

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,30 @@
+name: Publish Python Package
+
+on:
+  push:
+    tags:
+      - '*'
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: 
+      name: pypi
+      url: https://pypi.org/p/harmon_ai
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true

.gitignore

@@ -160,4 +160,6 @@ cython_debug/
 #.idea/
 
 SourceSageAssets
-tmp2.md
+tmp2.md
+.harmon_ai
+.Gaiah.md

app.py

@@ -1,15 +1,18 @@
 import streamlit as st
+from harmon_ai import HarmonAI
+# from templates.header import show_header
+# from templates.sidebar import show_sidebar
+# from templates.footer import show_footer
 
-
-# def load_markdown(file_path):
-#     with open(file_path, encoding="utf8") as f:
-#         return f.read()
-
-# def display_front_page():
-#     html_front = load_markdown('docs/page_front.md')
-#     st.markdown(f"{html_front}", unsafe_allow_html=True)
+def main():
+    # show_header()
+    # repo_name, owner_name, package_name, icon_url, title, subtitle, important_message = show_sidebar()
     
+    if st.button("Generate README"):
+        pass
+    #     readme_text = HarmonAI.generate_readme(repo_name, owner_name, package_name, icon_url, title, subtitle, important_message)
+    #     st.markdown(readme_text)
+    # show_footer()
+
 if __name__ == "__main__":
-    # display_front_page()
-    x = st.slider('Select a value')
-    st.write(x, 'squared is', x * x)
+    main()

harmon_ai/__init__.py

@@ -0,0 +1 @@
+from .harmon_ai import harmon_ai

harmon_ai/cli.py

@@ -0,0 +1,47 @@
+import argparse
+import os
+from .harmon_ai import harmon_ai
+
+def main():
+    parser = argparse.ArgumentParser(description="GitHubリポジトリ用のREADMEテンプレートとバッジを生成します。")
+    parser.add_argument("--repo_name", help="GitHubリポジトリの名前", default="your-repo")
+    parser.add_argument("--owner_name", help="リポジトリオーナーのGitHubユーザー名", default="your-github-username")
+    parser.add_argument("--package_name", help="パッケージの名前", default="your-package")
+    parser.add_argument("--icon_url", help="READMEに表示するアイコンのURL", default="https://example.com/icon.png")
+    parser.add_argument("--title", help="プロジェクトのタイトル", default="Your Project Title")
+    parser.add_argument("--subtitle", help="プロジェクトのサブタイトル", default="Your Project Subtitle")
+    parser.add_argument("--important_message", help="READMEに表示する重要なメッセージ", default=None)
+    parser.add_argument("--sections_content", help="READMEのセクションの内容（introduction, demo, getting_started, updates, contributing, license, acknowledgements）をマークダウン形式で指定", default=None)
+    parser.add_argument("--output_dir", help="生成されたREADMEファイルの出力ディレクトリ", default=".harmon_ai")
+    parser.add_argument("--output_file", help="生成されたREADMEファイルの名前", default="_README_template.md")
+
+    args = parser.parse_args()
+
+    if args.important_message is None:
+        with open(os.path.join(os.path.dirname(__file__), "templates", "important_template.md"), "r", encoding="utf8") as file:
+            args.important_message = file.read()
+
+    if args.sections_content is None:
+        with open(os.path.join(os.path.dirname(__file__), "templates", "sections_template.md"), "r", encoding="utf8") as file:
+            args.sections_content = file.read()
+
+    readme_template = harmon_ai.generate_readme(
+        args.repo_name,
+        args.owner_name,
+        args.package_name,
+        args.icon_url,
+        args.title,
+        args.subtitle,
+        args.important_message,
+        args.sections_content
+    )
+
+    os.makedirs(args.output_dir, exist_ok=True)
+    output_path = os.path.join(args.output_dir, args.output_file)
+    with open(output_path, "w", encoding="utf8") as file:
+        file.write(readme_template)
+
+    print(f"READMEファイルが生成されました: {output_path}")
+
+if __name__ == "__main__":
+    main()

harmon_ai/harmon_ai.py

@@ -0,0 +1,32 @@
+import os
+
+class harmon_ai:
+    @staticmethod
+    def generate_readme(repo_name, owner_name, package_name, icon_url, title, subtitle, important_message, sections_content):
+        with open(os.path.join(os.path.dirname(__file__), "templates", "readme_template.md"), "r") as file:
+            template = file.read()
+
+        badge_template = harmon_ai.generate_badges(repo_name, owner_name, package_name)
+
+        template = template.replace("{repo_name}", repo_name)
+        template = template.replace("{owner_name}", owner_name)
+        template = template.replace("{package_name}", package_name)
+        template = template.replace("{icon_url}", icon_url)
+        template = template.replace("{title}", title)
+        template = template.replace("{subtitle}", subtitle)
+        template = template.replace("{badges}", badge_template)
+        template = template.replace("{important_message}", important_message)
+        template = template.replace("{sections_content}", sections_content)
+
+        return template
+
+    @staticmethod
+    def generate_badges(repo_name, owner_name, package_name):
+        with open(os.path.join(os.path.dirname(__file__), "templates", "badges_template.md"), "r") as file:
+            template = file.read()
+
+        template = template.replace("{repo_name}", repo_name)
+        template = template.replace("{owner_name}", owner_name)
+        template = template.replace("{package_name}", package_name)
+
+        return template

harmon_ai/templates/__init__.py

@@ -0,0 +1 @@
+# Empty file

harmon_ai/templates/badges_template.md

@@ -0,0 +1,14 @@
+<img alt="PyPI - Version" src="https://img.shields.io/pypi/v/{package_name}">
+<img alt="PyPI - Format" src="https://img.shields.io/pypi/format/{package_name}">
+<img alt="PyPI - Implementation" src="https://img.shields.io/pypi/implementation/{package_name}">
+<img alt="PyPI - Status" src="https://img.shields.io/pypi/status/{package_name}">
+<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dd/{package_name}">
+<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dw/{package_name}">
+<a href="https://github.com/{owner_name}/{repo_name}" title="Go to GitHub repo"><img src="https://img.shields.io/static/v1?label={repo_name}&message={owner_name}&color=blue&logo=github"></a>
+<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/{owner_name}/{repo_name}">
+<a href="https://github.com/{owner_name}/{repo_name}"><img alt="forks - {owner_name}" src="https://img.shields.io/github/forks/{repo_name}/{owner_name}?style=social"></a>
+<a href="https://github.com/{owner_name}/{repo_name}"><img alt="GitHub Last Commit" src="https://img.shields.io/github/last-commit/{owner_name}/{repo_name}"></a>
+<a href="https://github.com/{owner_name}/{repo_name}"><img alt="GitHub Top Language" src="https://img.shields.io/github/languages/top/{owner_name}/{repo_name}"></a>
+<img alt="GitHub Release" src="https://img.shields.io/github/v/release/{owner_name}/{repo_name}?color=red">
+<img alt="GitHub Tag" src="https://img.shields.io/github/v/tag/{owner_name}/{repo_name}?sort=semver&color=orange">
+<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/{owner_name}/{repo_name}/publish-to-pypi.yml">

harmon_ai/templates/important_template.md

@@ -0,0 +1 @@
+このリポジトリは[SourceSage](https://github.com/Sunwood-ai-labs/SourceSage)を活用しており、リリースノートやREADME、コミットメッセージの9割は[SourceSage](https://github.com/Sunwood-ai-labs/SourceSage) ＋ [claude.ai](https://claude.ai/)で生成しています。

harmon_ai/templates/readme_template.md

@@ -0,0 +1,17 @@
+<p align="center">
+<img src="{icon_url}" width="100%">
+<br>
+<h1 align="center">{title}</h1>
+<h2 align="center">
+  {subtitle}
+<br>
+  {badges}
+
+</h2>
+
+</p>
+
+>[!IMPORTANT]
+>{important_message}
+
+{sections_content}

harmon_ai/templates/sections_template.md

@@ -0,0 +1,13 @@
+## 🌟 Introduction
+
+## 🎥 Demo
+
+## 🚀 Getting Started
+
+## 📝 Updates
+
+## 🤝 Contributing
+
+## 📄 License
+
+## 🙏 Acknowledgements

script/activate-harmon_ai_dev.bat

@@ -0,0 +1 @@
+conda activate harmon_ai_dev

setup.py

@@ -0,0 +1,26 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="harmon_ai",
+    version="0.1.0",
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=[
+        # Add any dependencies here
+    ],
+    entry_points={
+        "console_scripts": [
+            "harmon-ai = harmon_ai.cli:main"
+        ]
+    },
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+    ],
+)

tests/__init__.py

@@ -0,0 +1 @@
+# Empty file

tests/test_harmon_ai.py

@@ -0,0 +1,69 @@
+import unittest
+from harmon_ai import harmon_ai
+
+class Testharmon_ai(unittest.TestCase):
+    def test_generate_badges(self):
+        repo_name = "test-repo"
+        owner_name = "test-owner"
+        package_name = "test-package"
+        
+        with open("harmon_ai/templates/badges_template.html", "r") as file:
+            expected_output = file.read()
+
+        expected_output = expected_output.replace("{repo_name}", repo_name)
+        expected_output = expected_output.replace("{owner_name}", owner_name)
+        expected_output = expected_output.replace("{package_name}", package_name)
+        
+        result = harmon_ai.generate_badges(repo_name, owner_name, package_name)
+        self.assertEqual(result, expected_output)
+
+    def test_generate_readme(self):
+        repo_name = "test-repo"
+        owner_name = "test-owner"
+        package_name = "test-package"
+        icon_url = "https://example.com/icon.png"
+        title = "Test Title"
+        subtitle = "Test Subtitle"
+        important_message = "This is an important message."
+        
+        sections_content = '''
+    ## Introduction
+    This is the introduction.
+
+    ## Demo
+    This is the demo.
+
+    ## Getting Started
+    This is how to get started.
+
+    ## Updates
+    These are the updates.
+
+    ## Contributing
+    This is how to contribute.
+
+    ## License
+    This is the license.
+
+    ## Acknowledgements
+    These are the acknowledgements.
+'''
+        
+        with open("harmon_ai/templates/readme_template.md", "r") as file:
+            expected_output = file.read()
+
+        expected_output = expected_output.replace("{repo_name}", repo_name)
+        expected_output = expected_output.replace("{owner_name}", owner_name)
+        expected_output = expected_output.replace("{package_name}", package_name)
+        expected_output = expected_output.replace("{icon_url}", icon_url)
+        expected_output = expected_output.replace("{title}", title)
+        expected_output = expected_output.replace("{subtitle}", subtitle)
+        expected_output = expected_output.replace("{badges}", harmon_ai.generate_badges(repo_name, owner_name, package_name))
+        expected_output = expected_output.replace("{important_message}", important_message)
+        expected_output = expected_output.replace("{sections_content}", sections_content)
+        
+        result = harmon_ai.generate_readme(repo_name, owner_name, package_name, icon_url, title, subtitle, important_message, sections_content)
+        self.assertEqual(result, expected_output)
+
+if __name__ == "__main__":
+    unittest.main()