sleepydatapeek


Namesleepydatapeek JSON
Version 0.3.2 PyPI version JSON
download
home_pagehttps://github.com/anthonybench/datapeek
SummaryPeek at local datafiles fast!
upload_time2023-10-06 17:19:18
maintainer
docs_urlNone
authoranthonybench
requires_python>=3.10,<4.0
licenseGNU GPL
keywords pandas data
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # **DataPeek**
*A quick way to peek at local datafiles.*

<br />

## **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!

<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
# pip install sleepydatapeek
# pip install --upgrade sleepydatapeek

from sleepydatapeek import sleepydatapeek
from sys import argv, exit

sleepydatapeek(argv[1:])
exit(0)
```

Presuming you've named said function `emoji`, print the help message:
```sh
sleepydatapeek --help
```

<br />

## **Technologies 🧰**
<hr>

  - [Pandas](https://pandas.pydata.org/docs/)
  - [Tabulate](https://pypi.org/project/tabulate/)
  - [Typer](https://typer.tiangolo.com/)

<br />

## **Contribute 🤝**
<hr>

If you have opinions, submit a PR 😊.

<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 -->

![PyPI - License](https://img.shields.io/pypi/l/sleepydatapeek?style=plastic)

<!-- / -->
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": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "pandas,data",
    "author": "anthonybench",
    "author_email": "anythonybenchyep@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/6d/22/ffba18afc5acfc0d08cda6506f177c002a813221815556999b1bc721a29d/sleepydatapeek-0.3.2.tar.gz",
    "platform": null,
    "description": "# **DataPeek**\n*A quick way to peek at local datafiles.*\n\n<br />\n\n## **Welcome to sleepydatapeek!**\nIn 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.\\\n**DataPeek** has entered the chat!\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\n# pip install sleepydatapeek\n# pip install --upgrade sleepydatapeek\n\nfrom sleepydatapeek import sleepydatapeek\nfrom sys import argv, exit\n\nsleepydatapeek(argv[1:])\nexit(0)\n```\n\nPresuming you've named said function `emoji`, print the help message:\n```sh\nsleepydatapeek --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\n<br />\n\n## **Contribute \ud83e\udd1d**\n<hr>\n\nIf you have opinions, submit a PR \ud83d\ude0a.\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![PyPI - License](https://img.shields.io/pypi/l/sleepydatapeek?style=plastic)\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": "0.3.2",
    "project_urls": {
        "Homepage": "https://github.com/anthonybench/datapeek",
        "Repository": "https://github.com/anthonybench/datapeek"
    },
    "split_keywords": [
        "pandas",
        "data"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d98b28daabb77d0c50b905f5934783f265999a5166cf5978f10f610c0bea0eff",
                "md5": "b54311f5b85aa6835d144d2bbfbc26e0",
                "sha256": "c97cbe46826f73d08477ecca02bd4311eb76483730e66bb5f00784e2b5222b5e"
            },
            "downloads": -1,
            "filename": "sleepydatapeek-0.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b54311f5b85aa6835d144d2bbfbc26e0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 16281,
            "upload_time": "2023-10-06T17:19:16",
            "upload_time_iso_8601": "2023-10-06T17:19:16.855216Z",
            "url": "https://files.pythonhosted.org/packages/d9/8b/28daabb77d0c50b905f5934783f265999a5166cf5978f10f610c0bea0eff/sleepydatapeek-0.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6d22ffba18afc5acfc0d08cda6506f177c002a813221815556999b1bc721a29d",
                "md5": "bcc3659d21ff8270d2c4e4cb32b283b8",
                "sha256": "92517bac46cf77b7b6e8aa69f3a86b2ebd4ebcdb9d760a775cf6da7abcf3f84e"
            },
            "downloads": -1,
            "filename": "sleepydatapeek-0.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "bcc3659d21ff8270d2c4e4cb32b283b8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 15263,
            "upload_time": "2023-10-06T17:19:18",
            "upload_time_iso_8601": "2023-10-06T17:19:18.403056Z",
            "url": "https://files.pythonhosted.org/packages/6d/22/ffba18afc5acfc0d08cda6506f177c002a813221815556999b1bc721a29d/sleepydatapeek-0.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-06 17:19:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "anthonybench",
    "github_project": "datapeek",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "sleepydatapeek"
}
        
Elapsed time: 0.12916s