Skip to content

Latest commit

 

History

History
133 lines (107 loc) · 5.8 KB

README.md

File metadata and controls

133 lines (107 loc) · 5.8 KB
Raw


Mystic Library

～ Unlock the magic of AI ～

[🌐 Website] • [🐱 GitHub] [🐦 Twitter] • [🍀 Official Blog]

🌟 概要

Mystic Libraryは、AIを活用したプロンプトのライブラリです。開発者や創作者が、より効率的かつ高品質なプロンプトを作成するためのリソースを提供します。

✨ 特徴

  • 📚 多様なカテゴリのプロンプトテンプレート
    • 分析、コーディング、マインドマップ、ライティングなど
  • 🎯 プロンプトエンジニアリングのベストプラクティス
    • 効果的なプロンプトの書き方のヒントとコツ
  • 🤖 LLMとの統合
    • LLMとのシームレスな連携を想定したプロンプトの設計

📁 リポジトリの構造

MysticLibrary/
├─ docs/                                   # ドキュメント
├─ example/                                # 使用例
│  └─ example_usage.py                     # サンプルコード
├─ MysticLibrary/                          # メインパッケージ
│  ├─ core.py                              # コア機能
│  └─ __init__.py                          # パッケージ初期化
├─ prompts/                                # プロンプトテンプレート
│  ├─ audio/                               # 音声関連
│  │  ├─ amped_enka_lyrics.md
│  │  └─ comprehensive-improved-rap-prompt.md
│  ├─ aws-certification/                   # AWS認定関連
│  │  └─ AWS_CERTIFICATION_EXAM_GUIDE_TEMPLATE.md
│  ├─ coding/                              # コーディング関連
│  │  ├─ BEST_PROGRAMMING_PRACTICES_REQUIREMENTS_JA.md
│  │  ├─ Checklist_for_Developing_Python_Packages_and_Libraries.md
│  │  └─ Requirements_for_High-Quality_Code.md
│  ├─ Company-as-a-Code/                   # 企業コード化
│  ├─ diagram/                             # 図表関連
│  ├─ documentation/                       # ドキュメント関連
│  ├─ image/                               # 画像生成関連
│  ├─ meta/                                # メタプロンプト
│  ├─ methodology/                         # 方法論
│  ├─ mind-mapping/                        # マインドマップ
│  └─ writing/                             # ライティング
│     └─ slide/                            # プレゼン資料
├─ script/                                 # スクリプト
│  └─ MysticLibrary-dev.bat               # 開発用スクリプト
├─ .gitignore                              # Git除外設定
├─ README.md                               # プロジェクト説明
└─ setup.py                                # パッケージ設定

📦 パッケージの構成

🔧 コアモジュール

  • MysticLibrary/core.py: ライブラリのコア機能を提供
  • MysticLibrary/__init__.py: パッケージの初期化と公開インターフェース

📚 プロンプトカテゴリ

  • prompts/audio/: 音声・音楽関連のプロンプト
  • prompts/coding/: プログラミング関連のプロンプト
  • prompts/documentation/: ドキュメント作成用プロンプト
  • prompts/image/: 画像生成用プロンプト
  • prompts/meta/: メタプロンプトとプロンプト設計
  • prompts/methodology/: 方法論とベストプラクティス
  • prompts/mind-mapping/: マインドマップ作成用プロンプト
  • prompts/writing/: 文章作成用プロンプト

🚀 利用方法

  1. リポジトリのクローン:
git clone https://github.com/yourusername/MysticLibrary.git
cd MysticLibrary
  1. パッケージのインストール:
pip install -e .
  1. プロンプトの使用:
from MysticLibrary import core

# プロンプトの使用例は example/example_usage.py を参照

🤝 コントリビューション

Mystic Libraryは、コミュニティからの貢献を歓迎します：

  1. 新しいプロンプトテンプレートの追加
  2. 既存プロンプトの改善
  3. ドキュメントの充実化
  4. バグ修正や機能改善

コントリビューションの詳細については、CONTRIBUTING.mdを参照してください。

📄 ライセンス

このプロジェクトはMIT Licenseの下で公開されています。

📞 連絡先

✨ Mystic Libraryで、AIの魔法を解き放ちましょう！ ✨