Skip to content

Package built for a group project for UBC-MDS

License

Notifications You must be signed in to change notification settings

RamiroMejia/gdphelper

 
 

Repository files navigation

Documentation Status codecov

gdphelper

This package is designed to take the url of any of the several dozen GDP-related csv datasets from the Canadian Government Open Data Portal and download, clean load, summarize and visualize the data contained within.

It contains 4 functions:

gdpimporter: Downloads the zipped data, extracts, renames the appropriate csv, and returns a dataframe along with the title from the meta data.
gdpcleaner: Loads the data, removes spurious columns, renames used columns, scrubs and data issues. Returns a basic data frame and some category flags.
gdpdescribe : Evaluates the data category and generates summary statistics by year, region, industry, etc.
gdpplotter: Generates a set of visualizations of the data set according to the user's choices.

This package is built upon a bunch of popular packages in Python ecosystem, including zipfile, matplotlib, and pandas. What makes this package unique is that it incorporates the common functionalities and streamlines the workflow from downloading the data to performing simple EDA, specifically for the GDP-related data from the Canadian Government Open Data Portal.

Installation

$ pip install gdphelper

Usage

from gdphelper import gdpimporter
from gdphelper import gdpcleaner
from gdphelper import gdpdescribe
from gdphelper import gdpplotter

URL = "https://www150.statcan.gc.ca/n1/tbl/csv/36100400-eng.zip"
data_frame, title = gdpimporter.gdpimporter(URL)
clean_frame = gdpcleaner.gdpcleaner(data_frame)
gdpdescribe.gdpdescribe(clean_frame, "Value", "Location", stats=["mean", "median", "sd", "min", "max", "range_"], dec=2)
gdpplotter.gdpplotter(clean_frame)

for more detailed documentation, see: https://gdphelper.readthedocs.io/en/latest/

Contributors

Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

gdphelper was created by Aldo Barros, Gabriel Fairbrother, Ramiro Mejia, Wanying Ye. It is licensed under the terms of the MIT license.

Credits

gdphelper was created with cookiecutter and the py-pkgs-cookiecutter template.

About

Package built for a group project for UBC-MDS

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%