From 060bf78bb8537e920abee930ffd949a88ad286ae Mon Sep 17 00:00:00 2001 From: buchananja Date: Tue, 23 Apr 2024 15:59:49 +0100 Subject: [PATCH] Updated readme. --- README.md | 12 +++++++----- setup.py | 2 +- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1fc2220..f4553aa 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ # **dpyp** +*A convenience tool for small-scale data pipelines in Python*

imageimage

## About -- dpyp (data-pipe) is a pandas convenience wrapper for small-scale data pipelines. -- PyPI: https://pypi.org/project/dpyp/ +PyPI: https://pypi.org/project/dpyp/ ## Use -- dpyp allows users to gather target files from directories into data dictionaries. -- Users can then apply cleaning and transformation functions iteratively to dictionaries, making batch processing quick to write and highly readable. \ No newline at end of file +- Consists of six modules: 'calculate', 'clean', 'diagnose', 'read', 'text', and 'write'. +- Designed for use in small-scale Python pipelines with an emphasis on batch-processing via 'data-dictionaries'. +- Batch processing of data via dictionaries allows iterative functions to improve readability and ease of use. +- Built using a combination of base Python and pandas for writing robust small-scale pipelines with text manipulation capabilities for parsing csv/json etc. \ No newline at end of file diff --git a/setup.py b/setup.py index c82bd73..0aebadb 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ setup( name = 'dpyp', version = '1.0.0', - description = 'A pandas convenience wrapper for small-scale data pipelines', + description = 'A convenience tool for small-scale data pipelines in Python', author = 'James Buchanan', author_email = 'buchananja.github@pm.me', license = 'MIT',