Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Mirage-Core

日本語文章解析エンジン。伝統的な自然言語処理(NLP)とLLMを組み合わせたハイブリッドアーキテクチャを採用しています。

🚀 クイックスタート

Docker Hub から実行(最も簡単)

# Docker Hub から最新イメージを取得
docker pull stayforge/mirage:latest

# コンテナを起動
docker run -d -p 8000:8000 stayforge/mirage:latest

# API にアクセス
curl http://localhost:8000/analysis/health

Docker Compose で実行

# リポジトリをクローン
git clone https://github.com/[your-repo]/Mirage-Core.git
cd Mirage-Core

# Docker Compose で起動
docker-compose up -d

# API にアクセス
curl http://localhost:8000/analysis/health

詳細は DOCKER.md を参照

ローカル環境で実行

# 依存関係をインストール
pip install -r requirements.txt

# UniDic 辞書をダウンロード(初回のみ)
python -m unidic download

# API サーバーを起動
python main.py

📚 API ドキュメント

起動後、以下の URL でアクセス:

  • Swagger UI: http://localhost:8000/docs
  • ReDoc: http://localhost:8000/redoc
  • API ガイド: API.md

🧪 テスト

# 全テストを実行
pytest tests/ -v

# API テストのみ
pytest tests/test_api.py -v

# 分析機能テストのみ
pytest tests/test_analysis.py -v

🔄 CI/CD

GitHub Actions による自動ビルド・デプロイを設定済み

  • main ブランチ: stayforge/mirage:latest
  • dev ブランチ: stayforge/mirage:dev
  • バージョンタグ: stayforge/mirage:v1.0.0

セットアップ方法: CI_SETUP.md

🛠️ Tools

A tool to convert other formats (mainly Aozora Bunko) to .MDI

Supported file(text) formats:

Metadata

Release files for pymirage 0.1.1.dev2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pymirage 0.1.1.dev2
File Size Uploaded Provenance Actions
pymirage-0.1.1.dev2.tar.gz 23.2 kB With provenance Details for pymirage-0.1.1.dev2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pymirage 0.1.1.dev2
File Interpreter ABI Platform Actions
pymirage-0.1.1.dev2-py3-none-any.whl Python 3 none any Details for pymirage-0.1.1.dev2-py3-none-any.whl

Total release size: 43.4 kB

Release files / pymirage-0.1.1.dev2.tar.gz

Download URL pymirage-0.1.1.dev2.tar.gz
Size 23.2 kB
Tags Source
SHA-256 checksum
How to use checksums
f37ec537f7e1504f61fd8901e78f0f2845b9876a503452a9bfd4723402013de8
BLAKE2b-256 checksum
How to use checksums
00c043e4b3e0000905f0678edb7aa24ede9013a8061c85970507427d7c80cc1c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 3, 2026.

Transparency log

Release files / pymirage-0.1.1.dev2-py3-none-any.whl

Download URL pymirage-0.1.1.dev2-py3-none-any.whl
Size 20.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
179b7036b1fa13cd6ef224e604050a4a0948393bba7bc384c3812d1856333151
BLAKE2b-256 checksum
How to use checksums
dd84fd2aedcc7cbf98c8a3f9a0f244a02f9a56a243a5d229d7aa3d50040ab286
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 3, 2026.

Transparency log

Security for pymirage 0.1.1.dev2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for pymirage-0.1.1.dev2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 3, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page