You can use boolean logic (e.g. AND/OR/NOT) for complex search queries. For more help and examples, see the search documentation.
Search by package name:
my-package (implicit)
name:my-package (explicit)
Search by package filename:
filename:my-package.ext
Search by package tag:
tag:latest
Search by package version:
version:1.0.0
prerelease:true (prereleases)
prerelease:false (no prereleases)
Search by package architecture:
architecture:x86_64
Search by package distribution:
distribution:el
Search by package license:
license:MIT
Search by package format:
format:deb
Search by package status:
status:in_progress
Search by package file checksum:
checksum:5afba
Search by package security status:
severity:critical
Search by package vulnerabilities:
vulnerabilities:>1
vulnerabilities:<1000
Search by # of package downloads:
downloads:>8
downloads:<100
Search by package type:
type:binary
type:source
Search by package size (bytes):
size:>50000
size:<10000
Search by dependency name/version:
dependency:log4j
dependency:log4j=1.0.0
dependency:log4j>1.0.0
Search by uploaded date:
uploaded:>"1 day ago"
uploaded:<"August 14, 2022 EST"
Search by entitlement token (identifier):
entitlement:3lKPVJPosCsY
Search by policy violation:
policy_violated:true
deny_policy_violated:true
license_policy_violated:true
vulnerability_policy_violated:true
Search by repository:
repository:repo-name
Search by last download date:
last_downloaded:<"30 days ago"
last_downloaded:>"August 14, 2022 EST"
Search queries for all Debian-specific (and related) package types
Search by component:
deb_component:unstable
Search queries for all Maven-specific (and related) package types
Search by group ID:
maven_group_id:org.apache
Search queries for all Docker-specific (and related) package types
Search by image digest:
docker_image_digest:sha256:7c5..6d4
(full hashref only)
Search by layer digest:
docker_layer_digest:sha256:4c4..ae4
(full hashref only)
Search queries for all Generic-specific package types
Search by file path:
generic_filepath:path/to/file.txt
Search by directory:
generic_directory:path/to
Field type modifiers (depending on the type, you can influence behaviour)
For all queries, you can use:
~foo for negation
For string queries, you can use:
^foo to anchor to start of term
foo$ to anchor to end of term
foo*bar for fuzzy matching
For number/date or version queries, you can use:
>foo for values greater than
>=foo for values greater / equal
<foo for values less than
<=foo for values less / equal
Need a secure and centralised artifact repository to deliver Alpine,
Cargo,
CocoaPods,
Composer,
Conan,
Conda,
CRAN,
Dart,
Debian,
Docker,
Generic,
Go,
Helm,
Hex,
HuggingFace,
LuaRocks,
Maven,
MCP,
npm,
NuGet,
P2,
Python,
RedHat,
Ruby,
Swift,
Terraform,
Vagrant,
VSX,
Raw & More packages?
Cloudsmith is the new standard in Package / Artifact Management and Software Distribution.
With support for all major package formats, you can trust us to manage your software supply chain.
Alpine
Cargo
Composer
Dart
Debian
Docker
Go
Helm
Maven
npm
NuGet
RedHat
Ruby
Swift
Terraform
Raw
demo-docs
/
awesome-repo
buildstock-fetch
1.0.2
One-liner (summary)
Description
# buildstock-fetch
[](https://img.shields.io/github/v/release/switchbox-data/buildstock-fetch) [](https://github.com/switchbox-data/buildstock-fetch/actions/workflows/main.yml?query=branch%3Amain) [](https://img.shields.io/github/commit-activity/m/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 available on PyPI and can be installed via:
`bash pip install buildstock-fetch `
or
`bash uv pip install buildstock-fetch `
## 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).
| Status | Completed |
|---|---|
| Checksum (MD5) | 581d168ee75cb974d182ed5ca4f96e1f |
| Checksum (SHA-1) | 401752ff2b42e8a5aa8785c7d02b7a8c9ad0487d |
| Checksum (SHA-256) | 2803458a26029cc0d8a000e5c9d0f4705f6890d7368ecc66d4bcf9b734283c5b |
| Checksum (SHA-512) | c1cd44ac4f151af11283a9f5d55342c9513b9060c4cf14a673c0a23c17f92c4f34… |
| GPG Signature | |
| GPG Fingerprint | 6811684bac0b8895434e97bdd4391b8fb999e537 |
| Storage Region | Dublin, Ireland |
| Type | Binary (contains binaries and binary artifacts) |
| Uploaded At | 4 months, 3 weeks ago |
| Uploaded By |
|
| Slug Id | buildstock_fetch-102-py3-none-anywhl-kvz5 |
| Unique Id | dgGHyapnJYgmvJXx |
| Version (Raw) | 1.0.2 |
| Version (Parsed) |
|
| extended metadata | |
| Author | Switchbox <bryan@switch.box> |
| Classifiers | Intended Audience :: Developers | Programming Language :: Python | Programming Language :: Python :: 3 | Programming Language :: Python :: 3.10 | Programming Language :: Python :: 3.11 | Programming Language :: Python :: 3.12 | Programming Language :: Python :: 3.13 | Programming Language :: Python :: 3.9 | Topic :: Software Development :: Libraries :: Python Modules |
| Keywords | python |
| Metadata Version | 2.4 |
| Project Urls | Documentation, https://switchbox-data.github.io/buildstock-fetch/ | Homepage, https://switchbox-data.github.io/buildstock-fetch/ | Repository, https://github.com/switchbox-data/buildstock-fetch |
| Py Filetype | bdist_wheel |
| Py Version | py3 |
| Requires Dist | boto3>=1.33.0 | botocore>=1.33.0 | numpy>=1.26.4 | pandas>=2.0.0 | polars>=0.20.0 | pyarrow>=14.0.1 | questionary>=1.11.0 | requests>=2.32.3 | rich>=13.9.5 | typer>=0.9.0 |
| Requires Python | <4.0,>=3.9 |
| pkg | buildstock_fetch-1.0.2-py3-none… |
6
94.2 MB |
md5 | sha1 | sha256 | sha512 |
This package has 2516 files/directories.
| Newer |
|
buildstock-fetch |
7 |
|
||
| Newer |
|
buildstock-fetch |
8 |
|
||
| Newer |
|
buildstock-fetch |
6 |
|
||
| Newer |
|
buildstock-fetch |
7 |
|
||
| Newer |
|
buildstock-fetch |
9 |
|
||
| Newer |
|
buildstock-fetch |
6 |
|
||
| Newer |
|
buildstock-fetch |
6 |
|
||
| Newer |
|
buildstock-fetch |
7 |
|
||
| Newer |
|
buildstock-fetch |
9 |
|
||
| Newer |
|
buildstock-fetch |
5 |
|
||
|
|
buildstock-fetch |
6 |
|
|||
| Older |
|
buildstock-fetch |
6 |
|
||
| Older |
|
buildstock-fetch |
6 |
|
||
| Older |
|
buildstock-fetch |
5 |
|
Last scanned
4 months, 3 weeks ago
Scan result
Clean
Vulnerability count
0
Max. severity
UnknownPackage statistics are no longer available on cloudsmith.io. Please visit our new web app to access this feature.
You can embed a badge in another website that shows this or the latest version of this package.
To embed the badge for this specific package version, use the following:
[](https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/buildstock-fetch/1.0.2/a=noarch;xf=bdist_wheel;xn=buildstock-fetch;xv=py3/)|This version of 'buildstock-fetch' @ Cloudsmith|
.. |This version of 'buildstock-fetch' @ Cloudsmith| image:: https://api.cloudsmith.com/v1/badges/version/demo-docs/awesome-repo/python/buildstock-fetch/1.0.2/a=noarch;xf=bdist_wheel;xn=buildstock-fetch;xv=py3/?render=true
:target: https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/buildstock-fetch/1.0.2/a=noarch;xf=bdist_wheel;xn=buildstock-fetch;xv=py3/image::https://api.cloudsmith.com/v1/badges/version/demo-docs/awesome-repo/python/buildstock-fetch/1.0.2/a=noarch;xf=bdist_wheel;xn=buildstock-fetch;xv=py3/?render=true[link="https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/buildstock-fetch/1.0.2/a=noarch;xf=bdist_wheel;xn=buildstock-fetch;xv=py3/",title="This version of 'buildstock-fetch' @ Cloudsmith"]<a href="https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/buildstock-fetch/1.0.2/a=noarch;xf=bdist_wheel;xn=buildstock-fetch;xv=py3/"><img src="https://api.cloudsmith.com/v1/badges/version/demo-docs/awesome-repo/python/buildstock-fetch/1.0.2/a=noarch;xf=bdist_wheel;xn=buildstock-fetch;xv=py3/?render=true" alt="This version of 'buildstock-fetch' @ Cloudsmith" /></a>rendered as:
To embed the badge for the latest package version, use the following:
[](https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/buildstock-fetch/latest/a=noarch;xf=bdist_wheel;xn=buildstock-fetch;xv=py3/)|Latest version of 'buildstock-fetch' @ Cloudsmith|
.. |Latest version of 'buildstock-fetch' @ Cloudsmith| image:: https://api.cloudsmith.com/v1/badges/version/demo-docs/awesome-repo/python/buildstock-fetch/latest/a=noarch;xf=bdist_wheel;xn=buildstock-fetch;xv=py3/?render=true&show_latest=true
:target: https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/buildstock-fetch/latest/a=noarch;xf=bdist_wheel;xn=buildstock-fetch;xv=py3/image::https://api.cloudsmith.com/v1/badges/version/demo-docs/awesome-repo/python/buildstock-fetch/latest/a=noarch;xf=bdist_wheel;xn=buildstock-fetch;xv=py3/?render=true&show_latest=true[link="https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/buildstock-fetch/latest/a=noarch;xf=bdist_wheel;xn=buildstock-fetch;xv=py3/",title="Latest version of 'buildstock-fetch' @ Cloudsmith"]<a href="https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/buildstock-fetch/latest/a=noarch;xf=bdist_wheel;xn=buildstock-fetch;xv=py3/"><img src="https://api.cloudsmith.com/v1/badges/version/demo-docs/awesome-repo/python/buildstock-fetch/latest/a=noarch;xf=bdist_wheel;xn=buildstock-fetch;xv=py3/?render=true&show_latest=true" alt="Latest version of 'buildstock-fetch' @ Cloudsmith" /></a>rendered as:
These instructions assume you have setup the repository first (or read it).
To install/use buildstock-fetch @ version 1.0.2 ...
pip install 'buildstock-fetch==1.0.2'You can also install the latest version of this package:
pip install --upgrade 'buildstock-fetch'If necessary, you can specify the repository directly:
pip install \
--index-url=https://dl.cloudsmith.io/public/demo-docs/awesome-repo/python/simple/ \
buildstock-fetch==1.0.2If you've got a project requirements.txt file, you can specify this as a dependency:
--index-url=https://dl.cloudsmith.io/public/demo-docs/awesome-repo/python/simple/
buildstock-fetch==1.0.2In addition, you can use this repository as an extra index url. However, please read our documentation on this parameter before using it. For example in a requirements.txt file:
--extra-index-url=https://dl.cloudsmith.io/public/demo-docs/awesome-repo/python/simple/
buildstock-fetch==1.0.2