Skip to main content

qeds

This package provides a simplified interface to datasets that we use frequently.

Loading data

To see a list of available datasets run

import qeds
qeds.data.available()

To load one of the listed datasets run

df = qeds.data.load("dataset_name")

where dataset_name is replaced by one of the names returned by qeds.data.available().

When you first load a dataset, qeds will fetch the data from somewhere online. It will then save a local copy of the data to your hard drive. Subsequent requests to load a dataset (even in different python sessions) will first attempt to load the data from your hard drive and only fetch from online if necessary.

Configuration

The qeds library is configurable. Below is a listing of available configuration options.

To see a list of valid configuration options run

import qeds
qeds.data.config.describe_options()

To set a configuration use valourm.data.options[section.option] = value.

For example, to set the configuration option for the BLS api_key I would call:

import qeds
qeds.data.options["bls.api_key"] = "MY_API_KEY"

Developer docs

Contributing datasets

To contribute a dataset you need to implement a function _retrieve_{name} inside the file data/retrieve.py. This function is responsible for obtaining the data either “by hand” (data hard coded into the function) or from online. The function must return a pandas DataFrame with the data.

Metadata

Release files for qeds 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qeds 0.7.0
File Size Uploaded Provenance Actions
qeds-0.7.0.tar.gz 24.5 kB Without provenance Details for qeds-0.7.0.tar.gz

Release files / qeds-0.7.0.tar.gz

Download URL qeds-0.7.0.tar.gz
Size 24.5 kB
Tags Source
SHA-256 checksum
How to use checksums
3bc6a497ecd258a64eb6bcef3ad8e04994604cd5f35657bbfa40788dda58a3cb
BLAKE2b-256 checksum
How to use checksums
601937e890689c346a9cf157509995bfd0818046047a1b7f3c81e2dc5b9c3429
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.3

Security for qeds 0.7.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page