Skip to content

Commit

Permalink
Updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
buchananja committed Apr 23, 2024
1 parent af8bd45 commit 060bf78
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# **dpyp**
*A convenience tool for small-scale data pipelines in Python*

<p align = "center">
  <img src = "logo/dpyp_logo.png" alt = "image" width = "300" height = "300">
  <img src = "logo/dpyp_logo.png" alt = "image" width = "350" height = "350">
</p>

## 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.
- 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.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = '[email protected]',
license = 'MIT',
Expand Down

0 comments on commit 060bf78

Please sign in to comment.