FranchiseDepth commited on
Commit
9644d7b
·
verified ·
1 Parent(s): 6c9964b

Viewer: read every table from its CSV

Browse files
Files changed (1) hide show
  1. README.md +130 -130
README.md CHANGED
@@ -1,130 +1,130 @@
1
- ---
2
- license: cc-by-nc-4.0
3
- pretty_name: FranchiseDepth Franchise Database (Free Sample)
4
- language:
5
- - en
6
- tags:
7
- - franchise
8
- - fdd
9
- - franchise-disclosure-document
10
- - small-business
11
- - business
12
- - finance
13
- - sqlite
14
- task_categories:
15
- - table-question-answering
16
- size_categories:
17
- - 1K<n<10K
18
- configs:
19
- - config_name: brand_summary
20
- data_files: brand_summary.csv
21
- default: true
22
- - config_name: brands
23
- data_files: parquet/brands.parquet
24
- - config_name: fees
25
- data_files: parquet/fees.parquet
26
- - config_name: fee_notes
27
- data_files: parquet/fee_notes.parquet
28
- - config_name: item19_figures
29
- data_files: parquet/item19_figures.parquet
30
- - config_name: comparable_revenue
31
- data_files: parquet/comparable_revenue.parquet
32
- - config_name: outlets_by_year
33
- data_files: parquet/outlets_by_year.parquet
34
- - config_name: turnover_by_year
35
- data_files: parquet/turnover_by_year.parquet
36
- - config_name: closure_by_year
37
- data_files: parquet/closure_by_year.parquet
38
- - config_name: outlets_by_state
39
- data_files: parquet/outlets_by_state.parquet
40
- - config_name: agreement_terms
41
- data_files: parquet/agreement_terms.parquet
42
- - config_name: brand_metrics
43
- data_files: parquet/brand_metrics.parquet
44
- - config_name: alternatives
45
- data_files: parquet/alternatives.parquet
46
- - config_name: peer_ranks
47
- data_files: parquet/peer_ranks.parquet
48
- - config_name: value_ratios
49
- data_files: parquet/value_ratios.parquet
50
- ---
51
- # FranchiseDepth Franchise Database: free sample
52
-
53
- Fees, Item 19 earnings, closure rates, growth, outlets by state and agreement terms for 25 US franchise brands, parsed from each brand's Franchise Disclosure Document (FDD) as filed with a US state. It is in exactly the same format as the full database, so you can test your queries, notebooks or AI workflows before scaling up.
54
-
55
- **Full database:** 2,485 brands, with 13,225 Item 19 figures, closure rates for 1,865 brands and outlet growth for 2,265. Available at [franchisedepth.gumroad.com](https://franchisedepth.gumroad.com/l/franchise-database), along with single-industry packs (food, home services, fitness).
56
-
57
- Also on [GitHub](https://github.com/franchisedepth/franchise-database-sample) and [Kaggle](https://www.kaggle.com/datasets/franchisedepth/franchisedepth-franchise-database-free-sample). Compiled 2026-11-01. FDD year of the latest filing per brand: 15 from 2026, 7 from 2025, 3 from 2024.
58
-
59
- ## Quick start
60
-
61
- Each table is browsable in the viewer above (pick it from the subset menu). To query everything at once, download the repo and use the SQLite file:
62
-
63
- ```python
64
- import sqlite3
65
- import pandas as pd
66
-
67
- con = sqlite3.connect("franchisedepth.sqlite")
68
- pd.read_sql("""
69
- SELECT brand_name, total_investment_low_usd, closure_rate_pct, growth_pct
70
- FROM v_brand_summary
71
- ORDER BY closure_rate_pct
72
- """, con)
73
- ```
74
-
75
- More questions with their SQL are in `example_queries.sql`. No code? Open `franchisedepth.xlsx` or `brand_summary.csv` in Excel or Google Sheets, or start with `README.txt`.
76
-
77
- ## Tables
78
-
79
- | Table | One row per | Rows |
80
- |---|---|---|
81
- | brands | brand: identity, FDD year, source registry, hand-checked flag | 25 |
82
- | fees | brand: Item 5 initial fee, Item 6 royalty and marketing fund, Item 7 total investment | 25 |
83
- | fee_notes | brand: tiers, minimums and discounts as printed | 25 |
84
- | item19_figures | Item 19 figure: metric, cohort, outlet count, average, median, min, max, period, FDD page | 388 |
85
- | comparable_revenue | brand: one annual revenue figure picked by a fixed rule, for comparing brands | 25 |
86
- | outlets_by_year | brand × year × outlet type (Item 20 Table 1) | 219 |
87
- | turnover_by_year | brand × year: opened, terminated, non-renewed, reacquired, ceased, transferred (Table 3) | 75 |
88
- | closure_by_year | brand × year: closure rate on the method below | 75 |
89
- | outlets_by_state | brand × year × state | 2,366 |
90
- | agreement_terms | brand: Item 17 term, renewal, transfer fee, non-compete | 11 |
91
- | brand_metrics | brand: total outlets, closure rate, outlet growth, all-in fee | 25 |
92
- | alternatives | brand × similar brand | 250 |
93
- | peer_ranks | brand × measure: rank against peers | 171 |
94
- | value_ratios | brand: revenue relative to investment and to royalty | 25 |
95
-
96
- `table_docs` and `column_docs` inside the database describe every table and column. `AGENTS.md` has the same in prose, with units and what NULL means.
97
-
98
- ## Files
99
-
100
- - `franchisedepth.sqlite`: every table, four ready-made views and the column docs.
101
- - `csv/`, `parquet/`: each table as a file.
102
- - `franchisedepth.xlsx`: every table as a tab, plus a Compare tab (pick up to 5 brands).
103
- - `brand_summary.csv`: one row per brand with the key figures.
104
- - `brands.jsonl`, `profiles/`, `profiles_by_industry/`, `all_profiles.md`: one document per brand, for retrieval pipelines and AI uploads.
105
- - `AGENTS.md`, `AI_GUIDE.md`, `AI_INSTRUCTIONS.txt`: guides for analysts and AI assistants (ChatGPT, Claude, Gemini, Grok, Copilot, Perplexity).
106
- - `mcp/franchisedepth_mcp.py`: a read-only MCP server for Claude Desktop, Cursor and other MCP clients.
107
-
108
- ## Methods
109
-
110
- - **Closure rate** = franchised terminations, non-renewals and ceased operations ÷ franchised outlets at the start of each year, over the latest three years of Item 20. Where a cause is blank, it is filled from the table's start, opened and end counts. Transfers and reacquisitions are not closures.
111
- - **Outlet growth** = change in total outlets (franchised + company-owned) between the first and last year-end of the latest three years of Item 20.
112
- - **All-in fee** = royalty % + marketing-fund % of gross sales (Item 6).
113
- - NULL means not disclosed, never zero. Revenue is not profit. Figures describe the FDD year shown for each brand, not the present.
114
-
115
- ## Connect it to Claude Desktop (MCP)
116
-
117
- 1. Install uv (https://docs.astral.sh/uv/).
118
- 2. Add this to Claude Desktop's config (Settings > Developer > Edit config), with your own paths:
119
-
120
- ```json
121
- {"mcpServers": {"franchisedepth": {"command": "uv", "args": ["run", "--with", "mcp", "python", "C:/path/to/mcp/franchisedepth_mcp.py", "C:/path/to/franchisedepth.sqlite"]}}}
122
- ```
123
-
124
- 3. Restart Claude Desktop and ask, for example: "Which brands here have the lowest closure rate, and what does each cost to open?"
125
-
126
- The server opens the database read-only and refuses anything but SELECT queries.
127
-
128
- ## Licence
129
-
130
- CC BY-NC 4.0: free to share and adapt for non-commercial use with credit to FranchiseDepth (franchisedepth.com). Commercial use needs a paid licence; see `LICENSE.txt`. Information only, not financial or legal advice; verify figures against the FDD before relying on them.
 
1
+ ---
2
+ license: cc-by-nc-4.0
3
+ pretty_name: FranchiseDepth Franchise Database (Free Sample)
4
+ language:
5
+ - en
6
+ tags:
7
+ - franchise
8
+ - fdd
9
+ - franchise-disclosure-document
10
+ - small-business
11
+ - business
12
+ - finance
13
+ - sqlite
14
+ task_categories:
15
+ - table-question-answering
16
+ size_categories:
17
+ - 1K<n<10K
18
+ configs:
19
+ - config_name: brand_summary
20
+ data_files: brand_summary.csv
21
+ default: true
22
+ - config_name: brands
23
+ data_files: csv/brands.csv
24
+ - config_name: fees
25
+ data_files: csv/fees.csv
26
+ - config_name: fee_notes
27
+ data_files: csv/fee_notes.csv
28
+ - config_name: item19_figures
29
+ data_files: csv/item19_figures.csv
30
+ - config_name: comparable_revenue
31
+ data_files: csv/comparable_revenue.csv
32
+ - config_name: outlets_by_year
33
+ data_files: csv/outlets_by_year.csv
34
+ - config_name: turnover_by_year
35
+ data_files: csv/turnover_by_year.csv
36
+ - config_name: closure_by_year
37
+ data_files: csv/closure_by_year.csv
38
+ - config_name: outlets_by_state
39
+ data_files: csv/outlets_by_state.csv
40
+ - config_name: agreement_terms
41
+ data_files: csv/agreement_terms.csv
42
+ - config_name: brand_metrics
43
+ data_files: csv/brand_metrics.csv
44
+ - config_name: alternatives
45
+ data_files: csv/alternatives.csv
46
+ - config_name: peer_ranks
47
+ data_files: csv/peer_ranks.csv
48
+ - config_name: value_ratios
49
+ data_files: csv/value_ratios.csv
50
+ ---
51
+ # FranchiseDepth Franchise Database: free sample
52
+
53
+ Fees, Item 19 earnings, closure rates, growth, outlets by state and agreement terms for 25 US franchise brands, parsed from each brand's Franchise Disclosure Document (FDD) as filed with a US state. It is in exactly the same format as the full database, so you can test your queries, notebooks or AI workflows before scaling up.
54
+
55
+ **Full database:** 2,485 brands, with 13,225 Item 19 figures, closure rates for 1,865 brands and outlet growth for 2,265. Available at [franchisedepth.gumroad.com](https://franchisedepth.gumroad.com/l/franchise-database), along with single-industry packs (food, home services, fitness).
56
+
57
+ Also on [GitHub](https://github.com/franchisedepth/franchise-database-sample) and [Kaggle](https://www.kaggle.com/datasets/franchisedepth/franchisedepth-franchise-database-free-sample). Compiled 2026-11-01. FDD year of the latest filing per brand: 15 from 2026, 7 from 2025, 3 from 2024.
58
+
59
+ ## Quick start
60
+
61
+ Each table is browsable in the viewer above (pick it from the subset menu). To query everything at once, download the repo and use the SQLite file:
62
+
63
+ ```python
64
+ import sqlite3
65
+ import pandas as pd
66
+
67
+ con = sqlite3.connect("franchisedepth.sqlite")
68
+ pd.read_sql("""
69
+ SELECT brand_name, total_investment_low_usd, closure_rate_pct, growth_pct
70
+ FROM v_brand_summary
71
+ ORDER BY closure_rate_pct
72
+ """, con)
73
+ ```
74
+
75
+ More questions with their SQL are in `example_queries.sql`. No code? Open `franchisedepth.xlsx` or `brand_summary.csv` in Excel or Google Sheets, or start with `README.txt`.
76
+
77
+ ## Tables
78
+
79
+ | Table | One row per | Rows |
80
+ |---|---|---|
81
+ | brands | brand: identity, FDD year, source registry, hand-checked flag | 25 |
82
+ | fees | brand: Item 5 initial fee, Item 6 royalty and marketing fund, Item 7 total investment | 25 |
83
+ | fee_notes | brand: tiers, minimums and discounts as printed | 25 |
84
+ | item19_figures | Item 19 figure: metric, cohort, outlet count, average, median, min, max, period, FDD page | 388 |
85
+ | comparable_revenue | brand: one annual revenue figure picked by a fixed rule, for comparing brands | 25 |
86
+ | outlets_by_year | brand × year × outlet type (Item 20 Table 1) | 219 |
87
+ | turnover_by_year | brand × year: opened, terminated, non-renewed, reacquired, ceased, transferred (Table 3) | 75 |
88
+ | closure_by_year | brand × year: closure rate on the method below | 75 |
89
+ | outlets_by_state | brand × year × state | 2,366 |
90
+ | agreement_terms | brand: Item 17 term, renewal, transfer fee, non-compete | 11 |
91
+ | brand_metrics | brand: total outlets, closure rate, outlet growth, all-in fee | 25 |
92
+ | alternatives | brand × similar brand | 250 |
93
+ | peer_ranks | brand × measure: rank against peers | 171 |
94
+ | value_ratios | brand: revenue relative to investment and to royalty | 25 |
95
+
96
+ `table_docs` and `column_docs` inside the database describe every table and column. `AGENTS.md` has the same in prose, with units and what NULL means.
97
+
98
+ ## Files
99
+
100
+ - `franchisedepth.sqlite`: every table, four ready-made views and the column docs.
101
+ - `csv/`, `parquet/`: each table as a file.
102
+ - `franchisedepth.xlsx`: every table as a tab, plus a Compare tab (pick up to 5 brands).
103
+ - `brand_summary.csv`: one row per brand with the key figures.
104
+ - `brands.jsonl`, `profiles/`, `profiles_by_industry/`, `all_profiles.md`: one document per brand, for retrieval pipelines and AI uploads.
105
+ - `AGENTS.md`, `AI_GUIDE.md`, `AI_INSTRUCTIONS.txt`: guides for analysts and AI assistants (ChatGPT, Claude, Gemini, Grok, Copilot, Perplexity).
106
+ - `mcp/franchisedepth_mcp.py`: a read-only MCP server for Claude Desktop, Cursor and other MCP clients.
107
+
108
+ ## Methods
109
+
110
+ - **Closure rate** = franchised terminations, non-renewals and ceased operations ÷ franchised outlets at the start of each year, over the latest three years of Item 20. Where a cause is blank, it is filled from the table's start, opened and end counts. Transfers and reacquisitions are not closures.
111
+ - **Outlet growth** = change in total outlets (franchised + company-owned) between the first and last year-end of the latest three years of Item 20.
112
+ - **All-in fee** = royalty % + marketing-fund % of gross sales (Item 6).
113
+ - NULL means not disclosed, never zero. Revenue is not profit. Figures describe the FDD year shown for each brand, not the present.
114
+
115
+ ## Connect it to Claude Desktop (MCP)
116
+
117
+ 1. Install uv (https://docs.astral.sh/uv/).
118
+ 2. Add this to Claude Desktop's config (Settings > Developer > Edit config), with your own paths:
119
+
120
+ ```json
121
+ {"mcpServers": {"franchisedepth": {"command": "uv", "args": ["run", "--with", "mcp", "python", "C:/path/to/mcp/franchisedepth_mcp.py", "C:/path/to/franchisedepth.sqlite"]}}}
122
+ ```
123
+
124
+ 3. Restart Claude Desktop and ask, for example: "Which brands here have the lowest closure rate, and what does each cost to open?"
125
+
126
+ The server opens the database read-only and refuses anything but SELECT queries.
127
+
128
+ ## Licence
129
+
130
+ CC BY-NC 4.0: free to share and adapt for non-commercial use with credit to FranchiseDepth (franchisedepth.com). Commercial use needs a paid licence; see `LICENSE.txt`. Information only, not financial or legal advice; verify figures against the FDD before relying on them.