| Name | dirp JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | https://github.com/prettytrippy/dirp |
| Summary | Command-line recursive pretty printer for directories. |
| upload_time | 2024-08-23 20:57:46 |
| maintainer | None |
| docs_url | None |
| author | Tripp Dow |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# DIRP
DirP (DIRectory Print) is a command-line utility for pretty printing directories. It generates a nice looking tree representation of its first argument, assuming a valid path.
For example, running dirp while in the root directory of my [Akashic](https://github.com/prettytrippy/Akashic) project, we see:
```
(base) trippdow@This-Computer Akashic % dirp .
Akashic/
│ Documents/
│ __pycache__/
│ │ └── __init__.cpython-311.pyc
│ │ └── chat.cpython-310.pyc
│ │ └── chat.cpython-311.pyc
│ │ └── chatbots.cpython-310.pyc
│ │ └── chatbots.cpython-311.pyc
│ │ └── chunkers.cpython-311.pyc
│ │ └── embedders.cpython-311.pyc
│ │ └── file_io.cpython-311.pyc
│ │ └── retrieval.cpython-311.pyc
│ │ └── text_utilities.cpython-311.pyc
│ templates/
│ │ └── chat.html
│ │ └── collections.html
│ │ └── index.html
│ └── .env
│ └── .gitignore
│ └── README.md
│ └── __init__.py
│ └── app.py
│ └── architect.py
│ └── chat.py
│ └── chatbots.py
│ └── chunkers.py
│ └── collections.txt
│ └── embedders.py
│ └── file_io.py
│ └── llama_chat_format.py
│ └── playground.py
│ └── retrieval.py
│ └── text_utilities.py
│ └── webscraper.py
```
This output is useful for communicating directory structures to others over text, or prompting a chatbot assistant.
## Setup
#### From Github:
```git clone https://github.com/prettytrippy/dirp```
Edit your ```~/.bashrc```, ```~/.zshrc``` or other to say:
```alias dirp = "path/to/dir_print.py"```
#### From PyPI
```pip install dirp```
## Usage
```dirp path/to/directory/to/print```
## License
MIT License, see LICENSE.
Raw data
{
"_id": null,
"home_page": "https://github.com/prettytrippy/dirp",
"name": "dirp",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Tripp Dow",
"author_email": "trippdow@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f1/d3/04185ad56f8e9245e0d7d00b48c8acc3fc237918e33c2e4ada8ec8e442e4/dirp-0.0.1.tar.gz",
"platform": null,
"description": "# DIRP \n\nDirP (DIRectory Print) is a command-line utility for pretty printing directories. It generates a nice looking tree representation of its first argument, assuming a valid path. \n\nFor example, running dirp while in the root directory of my [Akashic](https://github.com/prettytrippy/Akashic) project, we see:\n\n```\n(base) trippdow@This-Computer Akashic % dirp .\nAkashic/\n\u2502 Documents/\n\u2502 __pycache__/\n\u2502 \u2502 \u2514\u2500\u2500 __init__.cpython-311.pyc\n\u2502 \u2502 \u2514\u2500\u2500 chat.cpython-310.pyc\n\u2502 \u2502 \u2514\u2500\u2500 chat.cpython-311.pyc\n\u2502 \u2502 \u2514\u2500\u2500 chatbots.cpython-310.pyc\n\u2502 \u2502 \u2514\u2500\u2500 chatbots.cpython-311.pyc\n\u2502 \u2502 \u2514\u2500\u2500 chunkers.cpython-311.pyc\n\u2502 \u2502 \u2514\u2500\u2500 embedders.cpython-311.pyc\n\u2502 \u2502 \u2514\u2500\u2500 file_io.cpython-311.pyc\n\u2502 \u2502 \u2514\u2500\u2500 retrieval.cpython-311.pyc\n\u2502 \u2502 \u2514\u2500\u2500 text_utilities.cpython-311.pyc\n\u2502 templates/\n\u2502 \u2502 \u2514\u2500\u2500 chat.html\n\u2502 \u2502 \u2514\u2500\u2500 collections.html\n\u2502 \u2502 \u2514\u2500\u2500 index.html\n\u2502 \u2514\u2500\u2500 .env\n\u2502 \u2514\u2500\u2500 .gitignore\n\u2502 \u2514\u2500\u2500 README.md\n\u2502 \u2514\u2500\u2500 __init__.py\n\u2502 \u2514\u2500\u2500 app.py\n\u2502 \u2514\u2500\u2500 architect.py\n\u2502 \u2514\u2500\u2500 chat.py\n\u2502 \u2514\u2500\u2500 chatbots.py\n\u2502 \u2514\u2500\u2500 chunkers.py\n\u2502 \u2514\u2500\u2500 collections.txt\n\u2502 \u2514\u2500\u2500 embedders.py\n\u2502 \u2514\u2500\u2500 file_io.py\n\u2502 \u2514\u2500\u2500 llama_chat_format.py\n\u2502 \u2514\u2500\u2500 playground.py\n\u2502 \u2514\u2500\u2500 retrieval.py\n\u2502 \u2514\u2500\u2500 text_utilities.py\n\u2502 \u2514\u2500\u2500 webscraper.py\n```\n\nThis output is useful for communicating directory structures to others over text, or prompting a chatbot assistant.\n\n## Setup\n\n#### From Github:\n\n```git clone https://github.com/prettytrippy/dirp```\n\nEdit your ```~/.bashrc```, ```~/.zshrc``` or other to say:\n```alias dirp = \"path/to/dir_print.py\"```\n\n#### From PyPI\n\n```pip install dirp```\n\n## Usage\n\n```dirp path/to/directory/to/print```\n\n## License\n\nMIT License, see LICENSE.\n",
"bugtrack_url": null,
"license": null,
"summary": "Command-line recursive pretty printer for directories.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/prettytrippy/dirp"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe0222260c6a72bd2378550a55fc41572f242e0698e14f4d02dc7d5b1d293c24",
"md5": "b274a8d37fd46228823180f13396af63",
"sha256": "ead88cb17f94cfe378fe566d59673c83ad3a522bff8f86334d5355d6404d5db3"
},
"downloads": -1,
"filename": "dirp-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b274a8d37fd46228823180f13396af63",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2828,
"upload_time": "2024-08-23T20:57:45",
"upload_time_iso_8601": "2024-08-23T20:57:45.172736Z",
"url": "https://files.pythonhosted.org/packages/fe/02/22260c6a72bd2378550a55fc41572f242e0698e14f4d02dc7d5b1d293c24/dirp-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f1d304185ad56f8e9245e0d7d00b48c8acc3fc237918e33c2e4ada8ec8e442e4",
"md5": "0aa6032f4fe051671fc806cb5ae777ca",
"sha256": "001a360b2cda9a8b949b8197304825a8e6bff5abdf6aacd0963b9e0e424d3ec1"
},
"downloads": -1,
"filename": "dirp-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "0aa6032f4fe051671fc806cb5ae777ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2646,
"upload_time": "2024-08-23T20:57:46",
"upload_time_iso_8601": "2024-08-23T20:57:46.684906Z",
"url": "https://files.pythonhosted.org/packages/f1/d3/04185ad56f8e9245e0d7d00b48c8acc3fc237918e33c2e4ada8ec8e442e4/dirp-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-23 20:57:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "prettytrippy",
"github_project": "dirp",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "dirp"
}