m1m02530125 Claude Sonnet 4.6 commited on
Commit
e36bba0
·
1 Parent(s): 5426886

docs: README.mdを記載

Browse files

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Files changed (1) hide show
  1. README.md +92 -1
README.md CHANGED
@@ -1 +1,92 @@
1
- # shift-tool
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # シフト表構築ツール
2
+
3
+ 飲食店向けのシフト表自動生成デスクトップアプリケーションです。
4
+ 従業員の希望シフトを入力するだけで、制約条件を満たした最適なシフト表を自動生成します。
5
+
6
+ ---
7
+
8
+ ## 主な機能
9
+
10
+ | 機能 | 内容 |
11
+ |---|---|
12
+ | 従業員管理 | 氏名・雇用形態・ポジション別習熟度・固定シフトパターンを登録 |
13
+ | 希望シフト入力 | 2週間単位で従業員ごとに勤務可能日・時間帯を入力 |
14
+ | シフト自動生成 | CP-SATソルバーによる最適化(人件費・スキルバランス・希望を考慮) |
15
+ | シフト編集 | 生成結果をカレンダー形式で確認・手動修正 |
16
+ | 出力 | PDF・Excel(.xlsx)形式でエクスポート |
17
+
18
+ ---
19
+
20
+ ## 店舗設定
21
+
22
+ | 時間帯 | 時間 | ポジション | 最低人数 | 最大人数 | ベテラン以上 |
23
+ |---|---|---|---|---|---|
24
+ | 朝食 | 6:00〜11:00 | ホール | 3名 | 4名 | 2名以上 |
25
+ | 朝食 | 6:00〜11:00 | キッチン | 3名 | 3名 | 1名以上 |
26
+ | ディナー | 17:00〜23:00 | ホール | 3名 | 3名 | 1名以上 |
27
+ | ディナー | 17:00〜23:00 | キッチン | 3名 | 3名 | 1名以上 |
28
+
29
+ ---
30
+
31
+ ## 技術スタック
32
+
33
+ | 用途 | ライブラリ |
34
+ |---|---|
35
+ | GUI | PyQt6 |
36
+ | 最適化 | Google OR-Tools(CP-SAT) |
37
+ | データベース | SQLite |
38
+ | Excel出力 | openpyxl |
39
+ | PDF出力 | reportlab |
40
+ | ビルド | PyInstaller + GitHub Actions |
41
+
42
+ ---
43
+
44
+ ## 最適化の優先順位
45
+
46
+ 1. 人件費の最小化(総労働時間・残業・深夜割増の削減)
47
+ 2. 残業・深夜勤務の特定人物への集中を回避
48
+ 3. 従業員の希望をなるべく通す
49
+ 4. 各日の人員配置のバランスを均等化
50
+
51
+ ---
52
+
53
+ ## セットアップ(開発環境)
54
+
55
+ ```bash
56
+ git clone https://github.com/Richiesss/shift-tool.git
57
+ cd shift-tool
58
+ pip install -r requirements.txt
59
+ python main.py
60
+ ```
61
+
62
+ **動作確認済み環境**: Python 3.11以上 / Windows 10・11
63
+
64
+ ---
65
+
66
+ ## Windows EXEのダウンロード
67
+
68
+ mainブランチへのプッシュ時にGitHub Actionsが自動でビルドします。
69
+
70
+ **[Releases](https://github.com/Richiesss/shift-tool/releases)** から最新の `シフト表構築ツール.exe` をダウンロードして実行してください。
71
+
72
+ > 初回起動時にWindows Defenderのスキャンで数秒かかる場合があります。
73
+ > SmartScreen の警告が出た場合は「詳細情報」→「実行」で起動できます。
74
+
75
+ ---
76
+
77
+ ## データの保存先
78
+
79
+ アプリのデータ(従業員情報・シフト履歴)はローカルに保存されます。
80
+
81
+ ```
82
+ Windows: C:\Users\<ユーザー名>\.shift_tool\shift_tool.db
83
+ Linux: ~/.shift_tool/shift_tool.db
84
+ ```
85
+
86
+ ---
87
+
88
+ ## 今後の予定(Phase 2)
89
+
90
+ - [ ] Google Forms CSVインポート(希望シフトの自動取り込み)
91
+ - [ ] 法令アラートの強化(36協定の週次集計表示)
92
+ - [ ] シフトパターンのテンプレート保存