Skip to main content

Hoopoe is a data enrichment service that makes it easy to improve your data-centric services and increase the accuracy of your ML models.

Project description

Hoopoe

A fast and easy way to enrich your data

Hoopoe is a data enrichment service that makes it easy to improve your data-centric services and increase the accuracy of your ML models.

Hoopoe saves you time in scraping data and loading it to Pandas Dataframes. Instead, just specify the data you already have in your dataframe and its type, and specify the desired data you would like to add.

Current development status

Hoopoe is in its early days, and offered as a pre-alpha version, therefore, bugs are expected. In addition, the current dataset avialability is low. You can check the list below to find out which datasets and translations are already available. This list will be updated from time to time.

Available datasets

  • US states
    • State name abbriviation (USPS abbreviation)
    • Full state name
    • State population
    • State capital city:
      • State capital city name
      • State capital city population:
        • Population
        • MSA/µSA population (Metropolitan statistical area / Micropolitan statistical area)
        • CSA population (Combined statistical area)
    • State area:
      • State area rank
  • Country calling codes (international call prefixes)
    • Country name
    • International calling code


Work in progress datasets

  • US states ISO 3166 code
  • US states area
  • US states time zone
  • US states density
  • US population rank
  • US states income rank
  • US states density rank
  • Population by country
  • Capital City by country
  • Countries time zone
  • Countries official language

How to use

Currently Hoopoe supports enrichments of Pandas Dataframes and single strings. For basic usage, after installation, import hoopoe and use the hoopoe enrich function as follows:
hoopoe.enrich(data, source_data_name, source_data_type, target_data_type)

data - Either a string or a Pandas dataframe.
source_data_name - the dataframe column name of the column you want to enrich.
source_data_type - the Hoopoe source data type. For example us_state_name_abbr for a column holding abbriviations of us state.
target_data_type - the target Hoopoe data type you would like Hoopoe to return. For example, for country name, return the target date type phone_prefix for country calling code.

Enrichment options

Category Source data type desc. Hoopoe source_data_type Target data type desc. Hoopoe target_data_type
Places Two letter abbriviations of USA states names us_state_name_abbr Full USA states name us_state_name_full
Places Full USA states name us_state_name_full Two letter abbriviations of USA states name us_state_name_abbr
Places Full USA states name us_state_name_full State population (2019) us_state_population
Places Full USA state name us_state_name_full State capital city name us_state_capital_city
Places Capital city name us_capital_city_name City population us_capital_city_population
Places Full USA state name us_state_name_full State area rank us_state_area_rank
Phone numbers Intenational phone prefix phone_prefix Country name country_name



Installing

To install Hoopoe, run the following in your virtualenv:

$ pip install hoopoe

Developing Hoopoe

To install Hoopoe, along with the tools you need to develop and run tests, run the following in your virtualenv:

$ pip install -e .[dev]

Dependencies

Dev dependencies (only for contributers)

Licence

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hoopoe-0.0.6.tar.gz (12.6 kB view details)

Uploaded Source

File details

Details for the file hoopoe-0.0.6.tar.gz.

File metadata

  • Download URL: hoopoe-0.0.6.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.6

File hashes

Hashes for hoopoe-0.0.6.tar.gz
Algorithm Hash digest
SHA256 9ad7ea812ebe3cef11d0fa6480e90bbce006e23af6d23564eb4aeb1fd72273e5
MD5 5a489260daa53704757b3496661450cd
BLAKE2b-256 57136342da29102099a51151346f94de48aeda8731d98b2787c3f0e3ca09b598

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page