buildstock-fetch 1.0.2__py3-none-any.whl → 1.0.4__py3-none-any.whl

{buildstock_fetch-1.0.2.dist-info → buildstock_fetch-1.0.4.dist-info}/METADATA

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: buildstock-fetch
-Version: 1.0.2
+Version: 1.0.4
 Summary: This library simplifies downloading building characteristics and load curve data from NREL's ResStock and ComStock projects.
-Author-email: Switchbox <bryan@switch.box>
+Author-email: Switchbox <hello@switch.box>
 Project-URL: Homepage, https://switchbox-data.github.io/buildstock-fetch/
 Project-URL: Repository, https://github.com/switchbox-data/buildstock-fetch
 Project-URL: Documentation, https://switchbox-data.github.io/buildstock-fetch/
@@ -23,12 +23,30 @@ Requires-Dist: requests>=2.32.3
 Requires-Dist: typer>=0.9.0
 Requires-Dist: rich>=13.9.5
 Requires-Dist: questionary>=1.11.0
-Requires-Dist: pandas>=2.0.0
-Requires-Dist: boto3>=1.33.0
-Requires-Dist: botocore>=1.33.0
-Requires-Dist: pyarrow>=14.0.1
 Requires-Dist: polars>=0.20.0
-Requires-Dist: numpy>=1.26.4
+Provides-Extra: test
+Requires-Dist: pytest>=7.2.0; extra == "test"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.4.2; extra == "docs"
+Requires-Dist: mkdocs-material>=8.5.10; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.26.1; extra == "docs"
+Provides-Extra: lint
+Requires-Dist: pre-commit>=2.20.0; extra == "lint"
+Requires-Dist: mypy>=0.991; extra == "lint"
+Requires-Dist: ruff>=0.11.5; extra == "lint"
+Requires-Dist: deptry>=0.23.0; extra == "lint"
+Requires-Dist: types-requests>=2.31.0; extra == "lint"
+Requires-Dist: types-boto3>=1.33.0; extra == "lint"
+Requires-Dist: pandas-stubs>=2.2.0; extra == "lint"
+Provides-Extra: dev-utils
+Requires-Dist: boto3>=1.33.0; extra == "dev-utils"
+Requires-Dist: botocore>=1.33.0; extra == "dev-utils"
+Requires-Dist: pyarrow>=14.0.1; extra == "dev-utils"
+Requires-Dist: numpy>=1.26.4; extra == "dev-utils"
+Requires-Dist: scikit-learn>=1.6.1; extra == "dev-utils"
+Provides-Extra: dev
+Requires-Dist: buildstock-fetch[dev-utils,docs,lint,test]; extra == "dev"
+Requires-Dist: tox-uv>=1.11.3; extra == "dev"
 Dynamic: license-file
 
 # buildstock-fetch
@@ -43,9 +61,9 @@ This library simplifies downloading building characteristics and load curve data
 - **Github repository**: <https://github.com/switchbox-data/buildstock-fetch/>
 - **Documentation** <https://switchbox-data.github.io/buildstock-fetch/>
 
-## Using the library
+## Installing the library
 
-`buildstock-fetch` is available on PyPI and can be installed via:
+`buildstock-fetch` is available on [PyPI](https://pypi.org/project/buildstock-fetch/) and can be installed via:
 
 ```bash
 pip install buildstock-fetch
@@ -54,9 +72,30 @@ pip install buildstock-fetch
 or
 
 ```bash
-uv pip install buildstock-fetch
+uv add buildstock-fetch
+```
+
+## Using the library
+
+To use the CLI tool in `buildstock-fetch` run:
+
+```bash
+bsf
+```
+
+to activate the interactive mode. Alternatively, provide the inputs directly. For example,
+
+```bash
+bsf --product resstock --release_year 2022 --weather_file tmy3 --release_version 1 --states CA --file_type "hpxml metadata" --upgrade_id "0 1 2" --output_directory ./CA_data
+```
+
+If the above options don't work, try:
+
+```bash
+python -m buildstock_fetch
 ```
 
+For more details about the usage, see [Usage](https://switchbox-data.github.io/buildstock-fetch/usage/)
 
 ## Developing the library