Skip to main content

Peek at local datafiles fast!

Project description

DataPeek

A quick way to peek at local datafiles.


Welcome to sleepydatapeek!

In short, it's hand to have something be able to spit out a configurable preview of data from a file, and bonus points if you can just as easily output in markdown. It would also be nice if said tool could read all the formats.
DataPeek has entered the chat!


Table of Contents 📖


  • Get Started
  • Usage
  • Technologies
  • Contribute
  • Acknowledgements
  • License/Stats/Author

Get Started 🚀


This repo is currently private, so adding this package is all the user needs to care about.


Usage ⚙


After setting up the tool, run ./main.py [-h|--help] to display this message:

This tool takes an input file path and outputs a limited dataframe to either stdout or a markdown file.


Limit defaults to 20 rows, and can be overwritten.
Format value has synonyms 'xlsx' and 'xls'.
--------------
Usage:
  ./sleepydatapeek.py --format=[parquet|csv|json|excel] --path=<path> [--output=<path>] [--limit=<row-limit>]
Examples:
  ./sleepydatapeek.py --format=csv --path=sample-data/data.csv
  ./sleepydatapeek.py --format=csv --path=sample-data/data.csv --limit=6
  ./sleepydatapeek.py --format=csv --path=sample-data/data.csv --output=results.md
Info:
  ./sleepydatapeek.py [-h|--help]
--------------

Technologies 🧰



Contribute 🤝


As stated in the welcome section, the corresponding GitHub repo is private.
However, feel free to reach out with opinions!


Acknowledgements 💙


Cheers to the chaos of modern life for needing personalized agility in schema assessment.


License, Stats, Author 📜


example image tag

PyPI - License

See License for the full license text.

This package was authored by Isaac Yep.

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

sleepydatapeek-0.1.8.tar.gz (15.5 kB view hashes)

Uploaded Source

Built Distribution

sleepydatapeek-0.1.8-py3-none-any.whl (16.7 kB view hashes)

Uploaded Python 3

Supported by

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