The Python Package for DataHerb
A DataHerb Core Service to Create and Load Datasets.
Install
pip install dataherb
Usage
Load Data into DataFrame
# Load the package
from dataherb.flora import Flora
# Initialize Flora service
# The Flora service holds all the dataset metadata
dataherb = Flora()
# Search datasets with keyword(s)
geo_datasets = dataherb.search("geo")
print(geo_datasets)
# Get a specific file from a dataset and load as DataFrame
tz_df = dataherb.herb(
"geonames_timezone"
).leaves.get(
"dataset/geonames_timezone.csv"
).data
print(tz_df)
Create Dataset Using Command Line Tool
We provide a template for dataset creation.
Before creating a dataset, it is recommended that the user reads the intro.
Use the following command line tool to create the metadata template.
dataherb create
Understanding DataHerb
What is DataHerb
DataHerb is an open data initiative to make the access of open datasets easier.
- A DataHerb or Herb is a dataset. A dataset comes with the data files, and the metadata of the data files.
- A DataHerb Leaf or Leaf is a data file in the DataHerb.
- A Flora is the combination of all the DataHerbs.
In many data projects, finding the right datasets to enhance your data is one of the most time consuming part. DataHerb adds flavor to your data project.
What is DataHerb Flora
We desigined the following workflow to share and index datasets.
This repository is being used for listing of datasets (Listings in DataHerb flora repository).
How to Add Your Dataset
Simply create a yml file in the flora folder to link to your dataset repository. Your dataset repository should have a .dataherb folder and a metadata.yml file in it.
The indexing part will be done by GitHub Actions.
Development
- Create a conda environment.
- Install requirements:
pip install -r requirements.txt
Documentation
The documentation for this package is located at docs.
HISTORY.rst is used to list changes of the package.
Metadata
Release files for dataherb 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| dataherb-0.0.2.tar.gz | 9.9 kB | Without provenance | Details for dataherb-0.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| dataherb-0.0.2-py3-none-any.whl | Python 3 | none | any | Details for dataherb-0.0.2-py3-none-any.whl |
Total release size: 22.4 kB
Release files / dataherb-0.0.2.tar.gz
| Download URL | dataherb-0.0.2.tar.gz |
|---|---|
| Size | 9.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3d8bfdd19805197fee45065477452d3d6a45187a3f14aada26ab258c9973ca36
|
|
BLAKE2b-256 checksum How to use checksums |
10f12a33ebd5619325770bccc44f6a4f49d726e8871762d9f03ae2a4dd938528
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.1
|
Release files / dataherb-0.0.2-py3-none-any.whl
| Download URL | dataherb-0.0.2-py3-none-any.whl |
|---|---|
| Size | 12.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e5f2c66c1a81b8f3e4f41d29cbdcb92a1add757e59d5102b56990d6f76afdb98
|
|
BLAKE2b-256 checksum How to use checksums |
16e5b44a160882f66736f860fd03f6263cfbe7e00db10a643ad588115c144ad3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.1
|
Security for dataherb 0.0.2
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.