comcheck-api 1.0.0__tar.gz → 1.0.1__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.
Files changed (138) hide show
  1. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/.gitignore +3 -0
  2. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/PKG-INFO +5 -13
  3. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/README.md +2 -2
  4. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/__init__.py +1 -1
  5. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/ai/skill/SKILL.md +1 -1
  6. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/index.md +1 -1
  7. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/mkdocs.yml +1 -1
  8. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/pyproject.toml +4 -13
  9. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/.env.example +0 -0
  10. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/.github/ISSUE_TEMPLATE/bug_report.md +0 -0
  11. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/.github/ISSUE_TEMPLATE/feature_request.md +0 -0
  12. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/.github/ISSUE_TEMPLATE/question.md +0 -0
  13. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/.github/pull_request_template.md +0 -0
  14. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/.github/workflows/docs.yml +0 -0
  15. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/.github/workflows/publish.yml +0 -0
  16. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/.pre-commit-config.yaml +0 -0
  17. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/.python-version +0 -0
  18. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/CHANGELOG.md +0 -0
  19. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/DISCLAIMER.md +0 -0
  20. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/LICENSE +0 -0
  21. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/ai/__init__.py +0 -0
  22. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/ai/skill/__init__.py +0 -0
  23. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/ai/skill/reference/operations.md +0 -0
  24. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/ai/skill/reference/simulation.md +0 -0
  25. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/ai/skill/reference/types.md +0 -0
  26. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/ai/skill/scripts/__init__.py +0 -0
  27. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/ai/skill/scripts/validate_code.py +0 -0
  28. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/api/__init__.py +0 -0
  29. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/api/api_services.py +0 -0
  30. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/cli.py +0 -0
  31. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/client/__init__.py +0 -0
  32. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/client/comcheck_client.py +0 -0
  33. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/constants/__init__.py +0 -0
  34. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/constants/building_area_constants.py +0 -0
  35. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/constants/common_constants.py +0 -0
  36. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/constants/envelope_constants.py +0 -0
  37. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/defaults.py +0 -0
  38. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/exceptions.py +0 -0
  39. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/introspection.py +0 -0
  40. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/managers/__init__.py +0 -0
  41. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/managers/components/__init__.py +0 -0
  42. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/managers/components/building_area.py +0 -0
  43. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/managers/components/envelope/__init__.py +0 -0
  44. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/managers/components/envelope/ag_wall.py +0 -0
  45. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/managers/components/envelope/bg_wall.py +0 -0
  46. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/managers/components/envelope/door.py +0 -0
  47. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/managers/components/envelope/floor.py +0 -0
  48. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/managers/components/envelope/roof.py +0 -0
  49. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/managers/components/envelope/skylight.py +0 -0
  50. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/managers/components/envelope/window.py +0 -0
  51. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/managers/data_manager.py +0 -0
  52. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/project_operations/__init__.py +0 -0
  53. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/project_operations/project_building_area_operations.py +0 -0
  54. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/project_operations/project_envelope_operations.py +0 -0
  55. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/schemas/comCheck.schema.json +0 -0
  56. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/types/__init__.py +0 -0
  57. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/types/api_types.py +0 -0
  58. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/types/common_types.py +0 -0
  59. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/types/core_types.py +0 -0
  60. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/types/custom_base_model.py +0 -0
  61. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/utilities/__init__.py +0 -0
  62. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/utilities/common.py +0 -0
  63. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/utilities/envelope_utilities.py +0 -0
  64. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/utilities/id_registry.py +0 -0
  65. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/utilities/project_utilities.py +0 -0
  66. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/comcheck_api/validation.py +0 -0
  67. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/api-service.md +0 -0
  68. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/client.md +0 -0
  69. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/constants/building-area.md +0 -0
  70. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/constants/common.md +0 -0
  71. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/constants/envelope.md +0 -0
  72. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/defaults.md +0 -0
  73. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/exceptions.md +0 -0
  74. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/introspection.md +0 -0
  75. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/managers/building-area.md +0 -0
  76. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/managers/data-manager.md +0 -0
  77. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/managers/envelope.md +0 -0
  78. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/operations/building-area.md +0 -0
  79. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/operations/credits.md +0 -0
  80. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/operations/envelope.md +0 -0
  81. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/operations/exterior-lighting.md +0 -0
  82. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/operations/interior-lighting.md +0 -0
  83. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/operations/mechanical.md +0 -0
  84. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/operations/renewable-energy.md +0 -0
  85. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/simulation.md +0 -0
  86. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/types/api-types.md +0 -0
  87. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/types/common-types.md +0 -0
  88. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/types/custom-base-model.md +0 -0
  89. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/utilities/common.md +0 -0
  90. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/utilities/envelope.md +0 -0
  91. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/api/utilities/id-registry.md +0 -0
  92. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/getting-started.md +0 -0
  93. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/docs_site/types-guide.md +0 -0
  94. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/examples/README.md +0 -0
  95. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/examples/client/simulation.py +0 -0
  96. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/examples/client/user_functions.py +0 -0
  97. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/examples/data_manager/building_area.py +0 -0
  98. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/examples/data_manager/envelope.py +0 -0
  99. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/examples/project_operations/building_area_operations.py +0 -0
  100. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/examples/project_operations/envelope_operations.py +0 -0
  101. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/pytest_fixtures/__init__.py +0 -0
  102. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/pytest_fixtures/components.py +0 -0
  103. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/scripts/README.md +0 -0
  104. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/scripts/__init__.py +0 -0
  105. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/scripts/comcheck_client_tests/__init__.py +0 -0
  106. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/scripts/comcheck_client_tests/simulation_script.py +0 -0
  107. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/scripts/comcheck_client_tests/user_function_script.py +0 -0
  108. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/scripts/main.py +0 -0
  109. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/scripts/project_operations_tests/__init__.py +0 -0
  110. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/scripts/project_operations_tests/building_area_operations_script.py +0 -0
  111. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/scripts/project_operations_tests/envelope_operations_script.py +0 -0
  112. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/scripts/script_test_data.py +0 -0
  113. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/README.md +0 -0
  114. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/__init__.py +0 -0
  115. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/client/test_simulation.py +0 -0
  116. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/client/test_user_functions.py +0 -0
  117. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/conftest.py +0 -0
  118. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/data_manager_tests/__init__.py +0 -0
  119. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/data_manager_tests/envelope_tests/__init__.py +0 -0
  120. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/data_manager_tests/envelope_tests/conftest.py +0 -0
  121. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/data_manager_tests/envelope_tests/test_bg_wall_list_manager.py +0 -0
  122. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/data_manager_tests/envelope_tests/test_door_list_manager.py +0 -0
  123. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/data_manager_tests/envelope_tests/test_envelope.py +0 -0
  124. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/data_manager_tests/envelope_tests/test_floor_list_manager.py +0 -0
  125. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/data_manager_tests/envelope_tests/test_roof_list_manager.py +0 -0
  126. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/data_manager_tests/envelope_tests/test_window_list_manager.py +0 -0
  127. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/data_manager_tests/test_data_manager.py +0 -0
  128. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/project_operation_tests/__init__.py +0 -0
  129. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/project_operation_tests/assertions/__init__.py +0 -0
  130. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/project_operation_tests/assertions/components.py +0 -0
  131. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/project_operation_tests/conftest.py +0 -0
  132. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/project_operation_tests/test_building_area_operations.py +0 -0
  133. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/project_operation_tests/test_envelope_operations.py +0 -0
  134. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/test_base_model.py +0 -0
  135. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tests/test_comcheck_client.py +0 -0
  136. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tools/fetch_comcheck_schema.sh +0 -0
  137. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/tools/generate_core_types.py +0 -0
  138. {comcheck_api-1.0.0 → comcheck_api-1.0.1}/uv.lock +0 -0
@@ -58,3 +58,6 @@ testprojectJson/
58
58
  site/
59
59
 
60
60
  .claude
61
+
62
+ # Build artifacts
63
+ dist/
@@ -1,7 +1,7 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: comcheck_api
3
- Version: 1.0.0
4
- Summary: COMcheck Web API Python Client
3
+ Version: 1.0.1
4
+ Summary: COMcheck API Python Package
5
5
  Project-URL: Homepage, https://pnnl.github.io/comcheckweb-api-python/
6
6
  Project-URL: Documentation, https://pnnl.github.io/comcheckweb-api-python/
7
7
  Project-URL: Repository, https://github.com/pnnl/comcheckweb-api-python
@@ -9,15 +9,7 @@ Author-email: Yanyan Zhu <yanyan.zhu@pnnl.gov>
9
9
  Maintainer-email: Yanyan Zhu <yanyan.zhu@pnnl.gov>, Weili Xu <weili.xu@pnnl.gov>
10
10
  License-Expression: BSD-3-Clause
11
11
  License-File: LICENSE
12
- Keywords: IECC,ashrae 90.1,building,comcheck,compliance,simulation
13
- Classifier: Development Status :: 5 - Production/Stable
14
- Classifier: Intended Audience :: Developers
15
- Classifier: Operating System :: OS Independent
16
- Classifier: Programming Language :: Python :: 3
17
- Classifier: Programming Language :: Python :: 3.12
18
- Classifier: Programming Language :: Python :: 3.13
19
- Classifier: Topic :: Scientific/Engineering
20
- Classifier: Typing :: Typed
12
+ Keywords: IECC,ashrae 90.1,comcheck,compliance,energy code,simulation
21
13
  Requires-Python: >=3.12
22
14
  Requires-Dist: httpx>=0.27.0
23
15
  Requires-Dist: jsonschema>=4.23.0
@@ -26,9 +18,9 @@ Requires-Dist: python-dotenv>=1.0.0
26
18
  Requires-Dist: types-jsonschema>=4.23.0
27
19
  Description-Content-Type: text/markdown
28
20
 
29
- # COMcheckWeb API — Python Package
21
+ # COMcheck API — Python Package
30
22
 
31
- This repository contains the COMcheckWeb API Python package. It provides tools and scripts for working with the COMcheckWeb API and is intended to be used as a Python package maintained with `uv` for package management.
23
+ A type-safe Python package for the [COMcheck Web API](https://comcheck.energycode.pnl.gov) PNNL's hosted service for commercial building energy-code (ASHRAE 90.1 / IECC) compliance. Use it to build COMcheck projects, run compliance simulations, and read results from Python over the live API. Requires a free Personal Access Token (see below). The package is maintained with `uv`.
32
24
 
33
25
  **Requirements:**
34
26
  - Python: `>=3.12`
@@ -1,6 +1,6 @@
1
- # COMcheckWeb API — Python Package
1
+ # COMcheck API — Python Package
2
2
 
3
- This repository contains the COMcheckWeb API Python package. It provides tools and scripts for working with the COMcheckWeb API and is intended to be used as a Python package maintained with `uv` for package management.
3
+ A type-safe Python package for the [COMcheck Web API](https://comcheck.energycode.pnl.gov) PNNL's hosted service for commercial building energy-code (ASHRAE 90.1 / IECC) compliance. Use it to build COMcheck projects, run compliance simulations, and read results from Python over the live API. Requires a free Personal Access Token (see below). The package is maintained with `uv`.
4
4
 
5
5
  **Requirements:**
6
6
  - Python: `>=3.12`
@@ -1,4 +1,4 @@
1
- """COMcheckWeb API - Python client for programmatic building energy code compliance.
1
+ """COMcheck API Python Package for programmatic building energy code compliance.
2
2
 
3
3
  This package provides a type-safe, automated interface to the U.S. Department of
4
4
  Energy's COMcheck Web API for building energy code compliance verification.
@@ -8,7 +8,7 @@ description: Use this skill when the user is writing Python code that uses
8
8
  validate building energy code compliance.
9
9
  ---
10
10
 
11
- # COMcheck API Python Client Skill
11
+ # COMcheck API Python Package Skill
12
12
 
13
13
  ## When to use this skill
14
14
 
@@ -1,4 +1,4 @@
1
- # COMcheck API - Python Client
1
+ # COMcheck API Python Package
2
2
 
3
3
  Type-safe Python client for the PNNL's [COMcheck Web](https://comcheck.energycode.pnl.gov/) for building energy code compliance verification.
4
4
 
@@ -1,4 +1,4 @@
1
- site_name: COMcheck API - Python Client
1
+ site_name: COMcheck API Python Package
2
2
  site_description: Type-safe Python client for the PNNL COMcheck Web API
3
3
  site_url: https://pnnl.github.io/comcheckweb-api-python/
4
4
  repo_url: https://github.com/pnnl/comcheckweb-api-python
@@ -4,8 +4,8 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "comcheck_api"
7
- version = "1.0.0"
8
- description = "COMcheck Web API Python Client"
7
+ version = "1.0.1"
8
+ description = "COMcheck API Python Package"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.12"
11
11
  license = "BSD-3-Clause"
@@ -21,20 +21,11 @@ keywords = [
21
21
  "comcheck",
22
22
  "compliance",
23
23
  "simulation",
24
- "building",
24
+ "energy code",
25
25
  "ashrae 90.1",
26
26
  "IECC",
27
27
  ]
28
- classifiers = [
29
- "Development Status :: 5 - Production/Stable",
30
- "Intended Audience :: Developers",
31
- "Operating System :: OS Independent",
32
- "Programming Language :: Python :: 3",
33
- "Programming Language :: Python :: 3.12",
34
- "Programming Language :: Python :: 3.13",
35
- "Topic :: Scientific/Engineering",
36
- "Typing :: Typed",
37
- ]
28
+
38
29
  dependencies = [
39
30
  "httpx>=0.27.0",
40
31
  "jsonschema>=4.23.0",
File without changes
File without changes
File without changes
File without changes
File without changes