Metadata-Version: 2.4
Name: muku-core
Version: 1.20260912.8
Summary: 飲食店のレジのジャーナルから、月次の数字を分解してExcelにまとめる
Author-email: 株式会社ムササビ <t.watabe@mssbworks.com>
License: ムク（muku-core）使用許諾条件
        
        著作権者：株式会社ムササビ（mssbworks）
        最終更新：2026年9月4日
        
        この文書は法律の専門家の確認を経ていません。正規版の公開前に確認を取ります。
        
        
        1. 著作権
        
        このソフトウェアおよび付属の文書の著作権は、株式会社ムササビに帰属します。
        
        
        2. できること
        
        使用権をお持ちの方は、ご自身が経営または勤務する店舗の数字を分析する目的で、
        このソフトウェアを使うことができます。台数や回数の制限はありません。
        
        出力されたワークブックやその中の数字は、お店のものです。
        どう使うかも、誰に見せるかも、お店の自由です。
        
        
        3. 別途の使用権が要ること
        
        次の使い方には、別途の使用権が要ります。事前にご相談ください。
        
          ・第三者の店舗の分析を、業として請け負うこと
            （コンサルティング・分析代行・顧問業務などの中で使うこと）
          ・自社のサービスや製品にこのソフトウェアを組み込んで提供すること
          ・研修・講座の教材として使うこと
        
        自分の店に使うのは自由です。人の店で商売にするなら、一度話をさせてください。
        
        
        4. 禁じること
        
          ・このソフトウェアの複製を、第三者に配布・販売・貸与すること
          ・改変したものを公開・配布すること
          ・使用権を持たない第三者に、鍵（muku_ で始まる文字列）を渡すこと
          ・著作権表示やこの条件文を削除すること
        
        コードは公開されていますが、公開されていることと自由に使えることは別です。
        
        
        5. 無保証
        
        このソフトウェアは現状のまま提供されます。
        
        出力される数字は、渡されたデータをそのまま集計したものです。
        データに欠けや誤りがあれば、出力にもそのまま出ます。
        数字をもとにした経営判断の結果について、著作権者は責任を負いません。
        
        ムクは判断しません。判断するのはお店です。
        
        
        6. 連絡先
        
        t.watabe@mssbworks.com
        https://mssbworks.com/muku/
        
Project-URL: Homepage, https://mssbworks.com/muku/
Project-URL: 使い方, https://mssbworks.com/muku/
Keywords: restaurant,pos,sales-analysis,airregi
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: Japanese
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Office/Business :: Financial :: Accounting
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: pandas>=2.0
Requires-Dist: openpyxl>=3.1
Requires-Dist: lxml>=5.0
Provides-Extra: test
Requires-Dist: pytest; extra == "test"

# muku-core

飲食店のレジのジャーナルを読んで、月の数字を分解し、Excelのワークブックにまとめます。

これは **「ムク」という商品の計算部分** です。単体では動きますが、単体では商品になりません。
ムクの本体は、数字をどう読んで何を問いかけるかを決めている憲章のほうで、そちらは
使用権をお持ちの方にお渡ししています。

- 商品ページ https://mssbworks.com/muku/

---

## できること

レジのジャーナルCSVを渡すと、正規化した3つの表（取引・明細・割引）に揃えて、
そこから18枚のタブを持つExcelのワークブックを作ります。

- 売上の分解（店内・テイクアウト・物販。レジが2台以上でも1冊にまとまります）
- 客数・客単価・組数・組単価・組人数
- 曜日別・時間帯別（チャネルで絞れます）
- 滞在時間・卓占有率
- カテゴリ別・商品ABC分析（原価を渡せば粗利率まで）
- 割引と返品
- 予算根拠（前年実績で埋めてあります）
- 検算（合計が合っているか、何が取れていないか）

**取れないものは空欄にします。推定で埋めません。**
レジによって取れるものが違うので、ワークブックの設定タブに
「このお店のレジから読めるもの」の一覧が出ます。

## 対応しているレジ

| | ジャーナル | 客数 | 原価 | 割引 |
|---|---|---|---|---|
| Airレジ | ○ | ×（Airメイトから） | ○ | ○ |
| Airメイト | — | ○（会計数） | △ | × |
| MDでん票くん | ○（画面のコピーから） | ○（人数） | ○ | × |

でん票くんは明細のCSV出力を持たないレジですが、日報のXLSXと伝票画面のコピーから
同じ精度で読めます。

## 使い方

ふだんはClaudeが呼び出すので、直接触る必要はありません。

```python
from v1core import airregi
from v1core.storeconfig import load
from v1core.workbook import build_workbook

config = load("store_config.json")
t = airregi.convert(["ジャーナル履歴_20260601-20260831.csv"], config=config)
build_workbook(t["txn"], t["lines"], t["discounts"], config,
               daily=daily, target_ym="2026-08", out_path="ワークブック_202608.xlsx")
```

レジが2台以上ある店は `v1core.multi.load(config)` を使います。

## 使用許諾

**オープンソースではありません。**

- **ご自身のお店の分析に使うのは自由です。**台数も回数も制限しません
- **第三者の店舗の分析を業として請け負う場合は、別途の使用権が要ります。**
  コンサルティング・分析代行・自社サービスへの組み込み・研修教材としての利用が該当します
- 複製の配布、改変版の公開は禁じています

コードが公開されていることと、自由に使えることは別です。
全文は同梱の `LICENSE.txt` をご覧ください。

人の店で商売に使いたい方は、一度ご連絡ください。断るためではなく、
一緒にやれることがあるかもしれないので。

## 連絡先

t.watabe@mssbworks.com
株式会社ムササビ（mssbworks）
