dataherb 0.0.2

Get clean datasets from DataHerb to boost your data science and data analysis projects

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

A Complete Tutorals

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

1. Create a conda environment.
2. 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.