renobrief 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 wujieli
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,60 @@
1
+ Metadata-Version: 2.4
2
+ Name: renobrief
3
+ Version: 0.1.0
4
+ Summary: Estimate home renovation budget ranges by room, style, and scope. Companion CLI for RenoBrief AI (https://renobrief.com).
5
+ Author: wujieli
6
+ License: MIT
7
+ Project-URL: Homepage, https://renobrief.com
8
+ Project-URL: Documentation, https://renobrief.com
9
+ Project-URL: Repository, https://github.com/wujieli0207/renobrief
10
+ Keywords: renovation,home-improvement,budget,remodel,interior-design,estimator
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: License :: OSI Approved :: MIT License
13
+ Classifier: Topic :: Home Automation
14
+ Classifier: Intended Audience :: End Users/Desktop
15
+ Requires-Python: >=3.8
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Dynamic: license-file
19
+
20
+ # renobrief
21
+
22
+ Estimate home renovation **budget ranges** by room, style, and scope — a small
23
+ companion tool for [RenoBrief AI](https://renobrief.com), which turns a room
24
+ photo into a redesigned image plus a contractor-ready one-page brief.
25
+
26
+ ## Install
27
+
28
+ ```bash
29
+ pip install renobrief
30
+ ```
31
+
32
+ ## CLI
33
+
34
+ ```bash
35
+ renobrief kitchen --style quiet_luxury --scope gut --sqft 200
36
+ # kitchen · quiet_luxury · gut
37
+ # Estimated budget: $44,800 – $186,667
38
+ # Get a full visual redesign + contractor-ready brief: https://renobrief.com
39
+ ```
40
+
41
+ ## Python
42
+
43
+ ```python
44
+ from renobrief import estimate
45
+
46
+ low, high = estimate("bathroom", style="japandi", scope="remodel")
47
+ print(low, high)
48
+ ```
49
+
50
+ Rooms: `bathroom`, `kitchen`, `bedroom`, `living_room`, `exterior`
51
+ Styles: `minimalist`, `farmhouse`, `modern`, `japandi`, `quiet_luxury`
52
+ Scopes: `refresh`, `remodel`, `gut`
53
+
54
+ > Figures are planning ballparks (US market), not quotes. For an actual
55
+ > redesigned visualization, materials list, and a brief a contractor can quote
56
+ > against, use **[RenoBrief AI](https://renobrief.com)**.
57
+
58
+ ## License
59
+
60
+ MIT
@@ -0,0 +1,41 @@
1
+ # renobrief
2
+
3
+ Estimate home renovation **budget ranges** by room, style, and scope — a small
4
+ companion tool for [RenoBrief AI](https://renobrief.com), which turns a room
5
+ photo into a redesigned image plus a contractor-ready one-page brief.
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ pip install renobrief
11
+ ```
12
+
13
+ ## CLI
14
+
15
+ ```bash
16
+ renobrief kitchen --style quiet_luxury --scope gut --sqft 200
17
+ # kitchen · quiet_luxury · gut
18
+ # Estimated budget: $44,800 – $186,667
19
+ # Get a full visual redesign + contractor-ready brief: https://renobrief.com
20
+ ```
21
+
22
+ ## Python
23
+
24
+ ```python
25
+ from renobrief import estimate
26
+
27
+ low, high = estimate("bathroom", style="japandi", scope="remodel")
28
+ print(low, high)
29
+ ```
30
+
31
+ Rooms: `bathroom`, `kitchen`, `bedroom`, `living_room`, `exterior`
32
+ Styles: `minimalist`, `farmhouse`, `modern`, `japandi`, `quiet_luxury`
33
+ Scopes: `refresh`, `remodel`, `gut`
34
+
35
+ > Figures are planning ballparks (US market), not quotes. For an actual
36
+ > redesigned visualization, materials list, and a brief a contractor can quote
37
+ > against, use **[RenoBrief AI](https://renobrief.com)**.
38
+
39
+ ## License
40
+
41
+ MIT
@@ -0,0 +1,30 @@
1
+ [build-system]
2
+ requires = ["setuptools>=61.0"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "renobrief"
7
+ version = "0.1.0"
8
+ description = "Estimate home renovation budget ranges by room, style, and scope. Companion CLI for RenoBrief AI (https://renobrief.com)."
9
+ readme = "README.md"
10
+ requires-python = ">=3.8"
11
+ license = { text = "MIT" }
12
+ authors = [{ name = "wujieli" }]
13
+ keywords = ["renovation", "home-improvement", "budget", "remodel", "interior-design", "estimator"]
14
+ classifiers = [
15
+ "Programming Language :: Python :: 3",
16
+ "License :: OSI Approved :: MIT License",
17
+ "Topic :: Home Automation",
18
+ "Intended Audience :: End Users/Desktop",
19
+ ]
20
+
21
+ [project.urls]
22
+ Homepage = "https://renobrief.com"
23
+ Documentation = "https://renobrief.com"
24
+ Repository = "https://github.com/wujieli0207/renobrief"
25
+
26
+ [project.scripts]
27
+ renobrief = "renobrief.cli:main"
28
+
29
+ [tool.setuptools]
30
+ packages = ["renobrief"]
@@ -0,0 +1,11 @@
1
+ """renobrief — home renovation budget range estimator.
2
+
3
+ Companion CLI/SDK for RenoBrief AI (https://renobrief.com), which turns a room
4
+ photo into a contractor-ready renovation brief with budget and materials.
5
+ """
6
+
7
+ from .estimator import estimate, ROOMS, STYLES, SCOPES
8
+
9
+ __all__ = ["estimate", "ROOMS", "STYLES", "SCOPES"]
10
+ __version__ = "0.1.0"
11
+ HOMEPAGE = "https://renobrief.com"
@@ -0,0 +1,29 @@
1
+ """Command line entry point: `renobrief`."""
2
+
3
+ import argparse
4
+
5
+ from .estimator import estimate, ROOMS, STYLES, SCOPES
6
+ from . import HOMEPAGE, __version__
7
+
8
+
9
+ def main(argv=None):
10
+ parser = argparse.ArgumentParser(
11
+ prog="renobrief",
12
+ description="Estimate a home renovation budget range. "
13
+ f"Full AI redesign + contractor brief at {HOMEPAGE}",
14
+ )
15
+ parser.add_argument("room", choices=sorted(ROOMS), help="room to renovate")
16
+ parser.add_argument("--style", default="modern", choices=sorted(STYLES))
17
+ parser.add_argument("--scope", default="remodel", choices=sorted(SCOPES))
18
+ parser.add_argument("--sqft", type=float, default=None, help="room size in sqft")
19
+ parser.add_argument("--version", action="version", version=f"renobrief {__version__}")
20
+ args = parser.parse_args(argv)
21
+
22
+ low, high = estimate(args.room, args.style, args.scope, args.sqft)
23
+ print(f"{args.room} · {args.style} · {args.scope}")
24
+ print(f"Estimated budget: ${low:,} – ${high:,}")
25
+ print(f"Get a full visual redesign + contractor-ready brief: {HOMEPAGE}")
26
+
27
+
28
+ if __name__ == "__main__":
29
+ main()
@@ -0,0 +1,53 @@
1
+ """Rough renovation budget ranges, US market, 2025-era figures.
2
+
3
+ Numbers are planning ballparks, not quotes. For a redesigned image plus a
4
+ one-page contractor-ready brief, see https://renobrief.com.
5
+ """
6
+
7
+ # Baseline low/high cost per room (USD), assuming a standard-size room.
8
+ ROOMS = {
9
+ "bathroom": (5_000, 25_000),
10
+ "kitchen": (12_000, 50_000),
11
+ "bedroom": (2_000, 15_000),
12
+ "living_room": (3_000, 20_000),
13
+ "exterior": (5_000, 40_000),
14
+ }
15
+
16
+ # Finish-level multiplier. Quiet luxury runs the highest.
17
+ STYLES = {
18
+ "minimalist": 0.9,
19
+ "farmhouse": 1.0,
20
+ "modern": 1.1,
21
+ "japandi": 1.15,
22
+ "quiet_luxury": 1.4,
23
+ }
24
+
25
+ # How deep the work goes.
26
+ SCOPES = {
27
+ "refresh": 0.4, # paint, fixtures, styling
28
+ "remodel": 1.0, # standard renovation
29
+ "gut": 1.6, # down to the studs
30
+ }
31
+
32
+
33
+ def estimate(room, style="modern", scope="remodel", sqft=None):
34
+ """Return a (low, high) budget range in USD.
35
+
36
+ room: one of ROOMS
37
+ style: one of STYLES (default "modern")
38
+ scope: one of SCOPES (default "remodel")
39
+ sqft: optional room size; scales the range relative to a ~120 sqft baseline.
40
+ """
41
+ if room not in ROOMS:
42
+ raise ValueError(f"unknown room {room!r}; choose from {sorted(ROOMS)}")
43
+ if style not in STYLES:
44
+ raise ValueError(f"unknown style {style!r}; choose from {sorted(STYLES)}")
45
+ if scope not in SCOPES:
46
+ raise ValueError(f"unknown scope {scope!r}; choose from {sorted(SCOPES)}")
47
+
48
+ low, high = ROOMS[room]
49
+ factor = STYLES[style] * SCOPES[scope]
50
+ if sqft:
51
+ factor *= max(0.5, float(sqft) / 120.0)
52
+
53
+ return round(low * factor), round(high * factor)
@@ -0,0 +1,60 @@
1
+ Metadata-Version: 2.4
2
+ Name: renobrief
3
+ Version: 0.1.0
4
+ Summary: Estimate home renovation budget ranges by room, style, and scope. Companion CLI for RenoBrief AI (https://renobrief.com).
5
+ Author: wujieli
6
+ License: MIT
7
+ Project-URL: Homepage, https://renobrief.com
8
+ Project-URL: Documentation, https://renobrief.com
9
+ Project-URL: Repository, https://github.com/wujieli0207/renobrief
10
+ Keywords: renovation,home-improvement,budget,remodel,interior-design,estimator
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: License :: OSI Approved :: MIT License
13
+ Classifier: Topic :: Home Automation
14
+ Classifier: Intended Audience :: End Users/Desktop
15
+ Requires-Python: >=3.8
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Dynamic: license-file
19
+
20
+ # renobrief
21
+
22
+ Estimate home renovation **budget ranges** by room, style, and scope — a small
23
+ companion tool for [RenoBrief AI](https://renobrief.com), which turns a room
24
+ photo into a redesigned image plus a contractor-ready one-page brief.
25
+
26
+ ## Install
27
+
28
+ ```bash
29
+ pip install renobrief
30
+ ```
31
+
32
+ ## CLI
33
+
34
+ ```bash
35
+ renobrief kitchen --style quiet_luxury --scope gut --sqft 200
36
+ # kitchen · quiet_luxury · gut
37
+ # Estimated budget: $44,800 – $186,667
38
+ # Get a full visual redesign + contractor-ready brief: https://renobrief.com
39
+ ```
40
+
41
+ ## Python
42
+
43
+ ```python
44
+ from renobrief import estimate
45
+
46
+ low, high = estimate("bathroom", style="japandi", scope="remodel")
47
+ print(low, high)
48
+ ```
49
+
50
+ Rooms: `bathroom`, `kitchen`, `bedroom`, `living_room`, `exterior`
51
+ Styles: `minimalist`, `farmhouse`, `modern`, `japandi`, `quiet_luxury`
52
+ Scopes: `refresh`, `remodel`, `gut`
53
+
54
+ > Figures are planning ballparks (US market), not quotes. For an actual
55
+ > redesigned visualization, materials list, and a brief a contractor can quote
56
+ > against, use **[RenoBrief AI](https://renobrief.com)**.
57
+
58
+ ## License
59
+
60
+ MIT
@@ -0,0 +1,11 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ renobrief/__init__.py
5
+ renobrief/cli.py
6
+ renobrief/estimator.py
7
+ renobrief.egg-info/PKG-INFO
8
+ renobrief.egg-info/SOURCES.txt
9
+ renobrief.egg-info/dependency_links.txt
10
+ renobrief.egg-info/entry_points.txt
11
+ renobrief.egg-info/top_level.txt
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ renobrief = renobrief.cli:main
@@ -0,0 +1 @@
1
+ renobrief
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+