buildstock-fetch 0.1.0__tar.gz → 1.0.0__tar.gz

buildstock_fetch-1.0.0/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include buildstock_fetch/utils *.json
+recursive-include buildstock_fetch/utils/building_data *

buildstock_fetch-1.0.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: buildstock-fetch
+Version: 1.0.0
+Summary: This library simplifies downloading building characteristics and load curve data from NREL's ResStock and ComStock projects.
+Author-email: Switchbox <bryan@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/
+Keywords: python
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <4.0,>=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+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
+Dynamic: license-file
+
+# buildstock-fetch
+
+[![Release](https://img.shields.io/github/v/release/switchbox-data/buildstock-fetch)](https://img.shields.io/github/v/release/switchbox-data/buildstock-fetch)
+[![Build status](https://img.shields.io/github/actions/workflow/status/switchbox-data/buildstock-fetch/main.yml?branch=main)](https://github.com/switchbox-data/buildstock-fetch/actions/workflows/main.yml?query=branch%3Amain)
+[![Commit activity](https://img.shields.io/github/commit-activity/m/switchbox-data/buildstock-fetch)](https://img.shields.io/github/commit-activity/m/switchbox-data/buildstock-fetch)
+[![License](https://img.shields.io/github/license/switchbox-data/buildstock-fetch)](https://img.shields.io/github/license/switchbox-data/buildstock-fetch)
+
+This library simplifies downloading building characteristics and load curve data from NREL's ResStock and ComStock projects.
+
+- **Github repository**: <https://github.com/switchbox-data/buildstock-fetch/>
+- **Documentation** <https://switchbox-data.github.io/buildstock-fetch/>
+
+## Using the library
+
+`buildstock-fetch` is currently in pre-release, so expect some bugs! The tool is not yet available on PyPI. In the meantime, install directly from the GitHub:
+
+```bash
+pip3 install git+https://github.com/switchbox-data/buildstock-fetch.git@main
+```
+
+## Developing the library
+
+To simplify development, this library uses [devcontainers](https://containers.dev/) for reproducible development environments and the [just](https://github.com/casey/just) command runner for all major tasks.
+
+Available commands are defined in [Justfile](Justile). To view available them:
+
+```bash
+just --list
+```
+
+### Setting up development environment
+
+This library uses [uv](https://docs.astral.sh/uv/) for managing python versions, virtual environments, and packages.
+
+However, given the presence of system dependencies, the easiest way to set up the library's develop environment is to use devcontainers. To do so, open up the repo in VSCode, or a VSCode fork like Cursor or Positron.
+
+The editor will auto-detect the presence of the repo's devcontainer (configured in [.devcontainer/devcontainer.json](.devcontainer/devcontainer.json)). Click "Reopen in Container" to launch the devcontainer.
+
+If you prefer not to use a devcontainer, you can install uv, install the pre-commit hooks, launch the virtualenv, and download the packages (pinned in [uv.lock](uv.lock)) by running:
+
+```bash
+./devcontainer/postCreateCommand.sh
+just install
+```
+
+Using a system package manager (like `brew` or `apt`), you'll also need to manually install `just` and `quarto`.
+
+### Adding a package
+To add a python package to the project:
+
+```bash
+uv add <package-name>
+```
+
+This replaces `pip install <package-name>`, and has the effect of adding the package to [pyproject.toml](pyproject.toml), as well as pinning the package version in [uv.lock](uv.lock).
+
+To add a package that will only be used as a development tool:
+
+```bash
+uv add --dev <package-name>
+```
+
+This will update the dev `dependency-groups` in [pyproject.toml](pyproject.toml), and ensure that the package isn't declared as a run-time dependency of the library itself.
+
+### Running code quality checks
+
+We use [ruff](https://github.com/astral-sh/ruff) for linting and code formatting, [mypy](https://mypy.readthedocs.io/en/stable/running_mypy.html) for type checking, and a series of [post-commit hooks](pre-commit-config.yaml) for validating YAML, JSON, whitespaces, and so on.
+
+To run code quality checks:
+
+```bash
+just check
+```
+
+The checks will also be run automatically by Github Actions when opening PRs, merging to main, or creating a new release.
+
+### Running tests
+
+Our test are written using `pytest` and live in [tests/](tests/). They are checked against multiple python versions using `tox`.
+
+To run the tests:
+
+```bash
+just test
+```
+
+### Rendering docs
+
+We use `mkdocs` and [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) for writing and rendering docs. The docs are written in markdown and live in [docs/](docs/).
+
+To dynamically render the docs as you develop them:
+
+```bash
+just docs
+```
+
+To statically render the docs into HTML:
+
+```bash
+just docs-test
+```
+
+The docs are served by Github Pages out of the `gh-pages` branch. We do not publish them manually: they are automatically rendered and published by the Github Actions workflow when merging to `main`.
+
+### Releasing the library
+
+To build the package into a wheel file, type:
+
+```bash
+just build
+```
+
+To publish a release to PyPI using [twine](https://pypi.org/project/twine/):
+
+```bash
+just publish
+```
+
+To do both in one go:
+
+```bash
+just build-and-publish
+```
+
+---
+
+Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).

buildstock_fetch-1.0.0/README.md

@@ -0,0 +1,127 @@
+# buildstock-fetch
+
+[![Release](https://img.shields.io/github/v/release/switchbox-data/buildstock-fetch)](https://img.shields.io/github/v/release/switchbox-data/buildstock-fetch)
+[![Build status](https://img.shields.io/github/actions/workflow/status/switchbox-data/buildstock-fetch/main.yml?branch=main)](https://github.com/switchbox-data/buildstock-fetch/actions/workflows/main.yml?query=branch%3Amain)
+[![Commit activity](https://img.shields.io/github/commit-activity/m/switchbox-data/buildstock-fetch)](https://img.shields.io/github/commit-activity/m/switchbox-data/buildstock-fetch)
+[![License](https://img.shields.io/github/license/switchbox-data/buildstock-fetch)](https://img.shields.io/github/license/switchbox-data/buildstock-fetch)
+
+This library simplifies downloading building characteristics and load curve data from NREL's ResStock and ComStock projects.
+
+- **Github repository**: <https://github.com/switchbox-data/buildstock-fetch/>
+- **Documentation** <https://switchbox-data.github.io/buildstock-fetch/>
+
+## Using the library
+
+`buildstock-fetch` is currently in pre-release, so expect some bugs! The tool is not yet available on PyPI. In the meantime, install directly from the GitHub:
+
+```bash
+pip3 install git+https://github.com/switchbox-data/buildstock-fetch.git@main
+```
+
+## Developing the library
+
+To simplify development, this library uses [devcontainers](https://containers.dev/) for reproducible development environments and the [just](https://github.com/casey/just) command runner for all major tasks.
+
+Available commands are defined in [Justfile](Justile). To view available them:
+
+```bash
+just --list
+```
+
+### Setting up development environment
+
+This library uses [uv](https://docs.astral.sh/uv/) for managing python versions, virtual environments, and packages.
+
+However, given the presence of system dependencies, the easiest way to set up the library's develop environment is to use devcontainers. To do so, open up the repo in VSCode, or a VSCode fork like Cursor or Positron.
+
+The editor will auto-detect the presence of the repo's devcontainer (configured in [.devcontainer/devcontainer.json](.devcontainer/devcontainer.json)). Click "Reopen in Container" to launch the devcontainer.
+
+If you prefer not to use a devcontainer, you can install uv, install the pre-commit hooks, launch the virtualenv, and download the packages (pinned in [uv.lock](uv.lock)) by running:
+
+```bash
+./devcontainer/postCreateCommand.sh
+just install
+```
+
+Using a system package manager (like `brew` or `apt`), you'll also need to manually install `just` and `quarto`.
+
+### Adding a package
+To add a python package to the project:
+
+```bash
+uv add <package-name>
+```
+
+This replaces `pip install <package-name>`, and has the effect of adding the package to [pyproject.toml](pyproject.toml), as well as pinning the package version in [uv.lock](uv.lock).
+
+To add a package that will only be used as a development tool:
+
+```bash
+uv add --dev <package-name>
+```
+
+This will update the dev `dependency-groups` in [pyproject.toml](pyproject.toml), and ensure that the package isn't declared as a run-time dependency of the library itself.
+
+### Running code quality checks
+
+We use [ruff](https://github.com/astral-sh/ruff) for linting and code formatting, [mypy](https://mypy.readthedocs.io/en/stable/running_mypy.html) for type checking, and a series of [post-commit hooks](pre-commit-config.yaml) for validating YAML, JSON, whitespaces, and so on.
+
+To run code quality checks:
+
+```bash
+just check
+```
+
+The checks will also be run automatically by Github Actions when opening PRs, merging to main, or creating a new release.
+
+### Running tests
+
+Our test are written using `pytest` and live in [tests/](tests/). They are checked against multiple python versions using `tox`.
+
+To run the tests:
+
+```bash
+just test
+```
+
+### Rendering docs
+
+We use `mkdocs` and [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) for writing and rendering docs. The docs are written in markdown and live in [docs/](docs/).
+
+To dynamically render the docs as you develop them:
+
+```bash
+just docs
+```
+
+To statically render the docs into HTML:
+
+```bash
+just docs-test
+```
+
+The docs are served by Github Pages out of the `gh-pages` branch. We do not publish them manually: they are automatically rendered and published by the Github Actions workflow when merging to `main`.
+
+### Releasing the library
+
+To build the package into a wheel file, type:
+
+```bash
+just build
+```
+
+To publish a release to PyPI using [twine](https://pypi.org/project/twine/):
+
+```bash
+just publish
+```
+
+To do both in one go:
+
+```bash
+just build-and-publish
+```
+
+---
+
+Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).