# **sleepydatapeek**
*A quick way to peek at local datafiles.*
<br />
## **Welcome to sleepydatapeek!**
One often needs to spit out a configurable preview of a data file. It would also be nice if said tool could detect and read several formats automatically.\
**`sleepydatapeek`** has entered the chat!
Quickly summarize data files such as:
- `csv`
- `parquet`
- `json`
<br />
### **Table of Contents** 📖
<hr>
- **Get Started**
- Usage
- Technologies
- Contribute
- Acknowledgements
- License/Stats/Author
<br />
## **Get Started 🚀**
<hr>
```sh
pip install sleepydatapeek
pip install --upgrade sleepydatapeek
```
<br />
## **Usage ⚙**
<hr>
Fetch dependencies:
```sh
pip install -r requirements.txt
```
Set a function in your shell environment to run a script like:
```sh
alias datapeek='python -m sleepydatapeek'
```
Presuming you've named said function `datapeek`, print the help message:
```sh
datapeek --help
```
<br />
## **Technologies 🧰**
<hr>
- [Pandas](https://pandas.pydata.org/docs/)
- [Tabulate](https://pypi.org/project/tabulate/)
- [Typer](https://typer.tiangolo.com/)
- [PyArrow](https://arrow.apache.org/docs/python/index.html)
<br />
## **Contribute 🤝**
<hr>
If you have thoughts on how to make the tool more pragmatic, submit a PR 😊.
To add support for more data/file types:
1. append extension name to `supported_formats` in `sleepydatapeek_toolchain.params.py`
2. add detection logic branch to `main` in `sleepydatapeek_toolchain/commands.py`
3. update this readme
<br />
## **Acknowledgements 💙**
<hr>
Cheers to the chaos of modern life for needing personalized agility in schema assessment.
<br />
## **License, Stats, Author 📜**
<hr>
<img align="right" alt="example image tag" src="https://i.imgur.com/jtNwEWu.png" width="200" />
<!-- badge cluster -->
<!-- / -->
See [License](LICENSE) for the full license text.
This package was authored by *Isaac Yep*.
Raw data
{
"_id": null,
"home_page": "https://github.com/anthonybench/datapeek",
"name": "sleepydatapeek",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "pandas, data",
"author": "anthonybench",
"author_email": "anythonybenchyep@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/11/99/42f62e73b0ae2cdb76b37fceb3905ebab7354a223a2b201746ffa79df01c/sleepydatapeek-1.0.4.tar.gz",
"platform": null,
"description": "# **sleepydatapeek**\n*A quick way to peek at local datafiles.*\n\n<br />\n\n## **Welcome to sleepydatapeek!**\nOne often needs to spit out a configurable preview of a data file. It would also be nice if said tool could detect and read several formats automatically.\\\n**`sleepydatapeek`** has entered the chat!\n\nQuickly summarize data files such as:\n- `csv`\n- `parquet`\n- `json`\n\n<br />\n\n### **Table of Contents** \ud83d\udcd6\n<hr>\n\n - **Get Started**\n - Usage\n - Technologies\n - Contribute\n - Acknowledgements\n - License/Stats/Author\n\n<br />\n\n## **Get Started \ud83d\ude80**\n<hr>\n\n```sh\npip install sleepydatapeek\npip install --upgrade sleepydatapeek\n```\n\n<br />\n\n## **Usage \u2699**\n<hr>\n\nFetch dependencies:\n```sh\npip install -r requirements.txt\n```\n\nSet a function in your shell environment to run a script like:\n```sh\nalias datapeek='python -m sleepydatapeek'\n```\n\nPresuming you've named said function `datapeek`, print the help message:\n```sh\ndatapeek --help\n```\n\n<br />\n\n## **Technologies \ud83e\uddf0**\n<hr>\n\n - [Pandas](https://pandas.pydata.org/docs/)\n - [Tabulate](https://pypi.org/project/tabulate/)\n - [Typer](https://typer.tiangolo.com/)\n - [PyArrow](https://arrow.apache.org/docs/python/index.html)\n\n<br />\n\n## **Contribute \ud83e\udd1d**\n<hr>\n\nIf you have thoughts on how to make the tool more pragmatic, submit a PR \ud83d\ude0a.\n\nTo add support for more data/file types:\n1. append extension name to `supported_formats` in `sleepydatapeek_toolchain.params.py`\n2. add detection logic branch to `main` in `sleepydatapeek_toolchain/commands.py`\n3. update this readme\n\n<br />\n\n## **Acknowledgements \ud83d\udc99**\n<hr>\n\nCheers to the chaos of modern life for needing personalized agility in schema assessment.\n\n<br />\n\n## **License, Stats, Author \ud83d\udcdc**\n<hr>\n\n<img align=\"right\" alt=\"example image tag\" src=\"https://i.imgur.com/jtNwEWu.png\" width=\"200\" />\n\n<!-- badge cluster -->\n\n\n\n<!-- / -->\nSee [License](LICENSE) for the full license text.\n\nThis package was authored by *Isaac Yep*.",
"bugtrack_url": null,
"license": "GNU GPL",
"summary": "Peek at local datafiles fast!",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/anthonybench/datapeek",
"Repository": "https://github.com/anthonybench/datapeek"
},
"split_keywords": [
"pandas",
" data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e386f5db5001b3bc4387a2820393ee6a2c241dbe9825c1a989cb67f2adcb0575",
"md5": "57db05f7fc6ebc27a53500a2e6859218",
"sha256": "ef4aa94dceb0bd805b2cc6f2f3867a9f781a825379522db9fde584bfc6266f39"
},
"downloads": -1,
"filename": "sleepydatapeek-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "57db05f7fc6ebc27a53500a2e6859218",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 16891,
"upload_time": "2025-03-22T02:04:10",
"upload_time_iso_8601": "2025-03-22T02:04:10.016827Z",
"url": "https://files.pythonhosted.org/packages/e3/86/f5db5001b3bc4387a2820393ee6a2c241dbe9825c1a989cb67f2adcb0575/sleepydatapeek-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "119942f62e73b0ae2cdb76b37fceb3905ebab7354a223a2b201746ffa79df01c",
"md5": "97d22db7602505de9cc3eb7f8c0b3527",
"sha256": "f5b056aaad9c209b88d51b66bf5320bb8026b9561219273131a1fc9ef445c6f6"
},
"downloads": -1,
"filename": "sleepydatapeek-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "97d22db7602505de9cc3eb7f8c0b3527",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 15725,
"upload_time": "2025-03-22T02:04:11",
"upload_time_iso_8601": "2025-03-22T02:04:11.359439Z",
"url": "https://files.pythonhosted.org/packages/11/99/42f62e73b0ae2cdb76b37fceb3905ebab7354a223a2b201746ffa79df01c/sleepydatapeek-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-22 02:04:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "anthonybench",
"github_project": "datapeek",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "pyarrow",
"specs": [
[
"~=",
"11.0.0"
]
]
},
{
"name": "typer",
"specs": [
[
"~=",
"0.15.2"
]
]
},
{
"name": "tabulate",
"specs": [
[
"~=",
"0.9.0"
]
]
},
{
"name": "pandas",
"specs": [
[
"~=",
"1.5.3"
]
]
}
],
"lcname": "sleepydatapeek"
}
JSON
