Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
96 lines (84 sloc) 4 KB
import setuptools
DESCRIPTION = "data wrangling simplicity, complete audit transparency, and at speed "
LONG_DESCRIPTION = """
**whyqd** provides an intuitive method for restructuring messy data to conform to a standardised
metadata schema. It supports data managers and researchers looking to rapidly, and continuously,
normalise any messy spreadsheets using a simple series of steps. Once complete, you can import
wrangled data into more complex analytical systems or full-feature wrangling tools.
It aims to get you to the point where you can perform automated data munging prior to
committing your data into a database, and no further. It is built on Pandas, and plays well with
existing Python-based data-analytical tools. Each raw source file will produce a json schema and
method file which defines the set of actions to be performed to produce refined data, and a
destination file validated against that schema.
**whyqd** ensures complete audit transparency by saving all actions performed to restructure
your input data to a separate json-defined methods file. This permits others to scrutinise your
approach, validate your methodology, or even use your methods to import data in production.
Once complete, a method file can be shared, along with your input data, and anyone can
import **whyqd** and validate your method to verify that your output data is the product of these
inputs.
## Why use it?
If all you want to do is test whether your source data are even useful, spending days or weeks
slogging through data restructuring could kill a project. If you already have a workflow and
established software which includes Python and pandas, having to change your code every time your
source data changes is really, really frustrating.
There are two complex and time-consuming parts to preparing data for analysis: social, and technical.
The social part requires multi-stakeholder engagement with source data-publishers, and with
destination database users, to agree structural metadata. Without any agreement on data publication
formats or destination structure, you are left with the tedious frustration of manually wrangling
each independent dataset into a single schema.
**whyqd** allows you to get to work without requiring you to achieve buy-in from anyone or change
your existing code.
## Wrangling process
- Create, update or import a data schema which defines the destination data structure;
- Create a new method and associate it with your schema and input data source/s;
- Assign a foreign key column and (if required) merge input data sources;
- Structure input data fields to conform to the requriements for each schema field;
- Assign categorical data identified during structuring;
- Transform and filter input data to produce a final destination data file;
- Share your data and a citation;
"""
DISTNAME = "whyqd"
LICENSE = "BSD"
AUTHOR = "Gavin Chait"
EMAIL = "gchait@whythawk.com"
URL = "http://whyqd.com"
DOWNLOAD_URL = ""
PROJECT_URLS = {
"Bug Tracker": "https://github.com/whythawk/whyqd/issues/",
"Documentation": "https://whyqd.readthedocs.io/",
"Source Code": "https://github.com/whythawk/whyqd/",
}
INSTALL_REQUIRES = [
"openpyxl>=3.0.3",
"pandas>=1.0.0",
"tabulate>=0.8.3",
"xlrd>=1.2.0",
"numpy>=1.18.1",
]
CLASSIFIERS = [
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Topic :: Scientific/Engineering"
]
setuptools.setup(
name=DISTNAME,
version="0.2.0",
author=AUTHOR,
author_email=EMAIL,
description=DESCRIPTION,
long_description=LONG_DESCRIPTION,
long_description_content_type="text/markdown",
license=LICENSE,
url=URL,
download_url=DOWNLOAD_URL,
project_urls=PROJECT_URLS,
classifiers=CLASSIFIERS,
packages=setuptools.find_packages(),
python_requires='>=3.6',
install_requires=INSTALL_REQUIRES,
)
You can’t perform that action at this time.