| Name | awesome-structure JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Всего одна команда в терминале, отделяющая вас от наслаждения прекрасной структурой вашего проекта 😌 |
| upload_time | 2025-07-13 15:56:59 |
| maintainer | None |
| docs_url | None |
| author | Dmitry-Peskov |
| requires_python | <4.0,>=3.10 |
| license | None |
| keywords |
cli
directory
tree
visualization
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# awesome-structure
### О пакете
---
>Всего одна команда в терминале, отделяющая вас от наслаждения прекрасной структурой вашего проекта 😌
**CLI** (_Command Line Interface_) приложение для построения красивой визуализации структуры произвольного каталога.
Например, для этого проекта, оно генерирует следующую визуализацию:
```
📁 awesome-structure
├── 📁 src
│ ├── 📁 awesome_structure
│ │ ├── 📁 renderers
│ │ │ ├── 🐍 __init__.py
│ │ │ ├── 🐍 icons.py
│ │ │ ├── 🐍 markdown.py
│ │ │ └── 🐍 terminal.py
│ │ ├── 🐍 __init__.py
│ │ ├── 🐍 cli.py
│ │ └── 🐍 tree_builder.py
│ └── 🐍 __init__.py
├── 📁 tests
│ ├── 📁 test_renderers
│ │ ├── 🐍 test_markdown.py
│ │ └── 🐍 test_terminal.py
│ ├── 🐍 __init__.py
│ ├── 🐍 conftest.py
│ ├── 🐍 test_cli.py
│ └── 🐍 test_tree_builder.py
├── 📄 .gitignore
├── 📄 LICENSE
├── 📄 poetry.lock
├── ⚙️ pyproject.toml
└── 📖 README.md
```
### Установка
---
Пакет опубликован в PyPi: **[awesome-structure](https://pypi.org/project/awesome-structure/)**
Воспользуйтесь удобным для вас менеджером пакетов:
**pip**
```shell
pip install awesome-structure
```
**poetry**
```shell
poetry add awesome-structure
```
### Использование
---
Вызовите ту самую заветную команду ``admire`` с указанием параметра пути к каталогу для получения удовольствия, так:
```shell
awesome-structure admire "[путь к вашему каталогу]"
```
или с явным казанием параметра ``--path`` так:
```shell
awesome-structure admire --path "[путь к вашему каталогу]"
```
Пример:
```shell
awesome-structure admire "C:\Program Files"
```
**Для корректной работы, настоятельно рекомендуется заключать путь в кавычки "".**
Результат будет выведен в терминал.
Если вы желаете получить результат в виде файла, доступно сохранение **markdown** разметки в файл _**awesome-structure.md**_.
Просто при вызове команды укажите соответствующее значение в параметре ``mode``
```shell
awesome-structure admire "C:\Program Files" --mode markdown
```
Файл будет сохранён в том каталоге, для которого строится визуализация.
По умолчанию, все скрытые файлы и каталоги (те, чьё название начинается с "**.**") не попадают в вывод результата.
К ним могут относиться ``.env``, ``.gitignore`` и т.д.
Если вы хотите включить в вывод скрытые папки и файлы, добавьте к команде флаг ``--hidden``.
```shell
awesome-structure admire "C:\Program Files" --hidden
```
Флаги можно комбинировать и использоваться совместно. Например:
```shell
awesome-structure admire "C:\Program Files" --mode markdown --hidden
```
Порядок следования флагов не важен
```shell
awesome-structure admire "C:\Program Files" --hidden --mode markdown
```
Raw data
{
"_id": null,
"home_page": null,
"name": "awesome-structure",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "cli, directory, tree, visualization",
"author": "Dmitry-Peskov",
"author_email": "dv.peskov@yandex.ru",
"download_url": "https://files.pythonhosted.org/packages/90/1e/1cf461b69f8fc0c22628f1b8350d9abbde4933bd1f648dff11485d87f95c/awesome_structure-0.1.1.tar.gz",
"platform": null,
"description": "# awesome-structure\n### \u041e \u043f\u0430\u043a\u0435\u0442\u0435\n\n---\n\n>\u0412\u0441\u0435\u0433\u043e \u043e\u0434\u043d\u0430 \u043a\u043e\u043c\u0430\u043d\u0434\u0430 \u0432 \u0442\u0435\u0440\u043c\u0438\u043d\u0430\u043b\u0435, \u043e\u0442\u0434\u0435\u043b\u044f\u044e\u0449\u0430\u044f \u0432\u0430\u0441 \u043e\u0442 \u043d\u0430\u0441\u043b\u0430\u0436\u0434\u0435\u043d\u0438\u044f \u043f\u0440\u0435\u043a\u0440\u0430\u0441\u043d\u043e\u0439 \u0441\u0442\u0440\u0443\u043a\u0442\u0443\u0440\u043e\u0439 \u0432\u0430\u0448\u0435\u0433\u043e \u043f\u0440\u043e\u0435\u043a\u0442\u0430 \ud83d\ude0c\n\n**CLI** (_Command Line Interface_) \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u0434\u043b\u044f \u043f\u043e\u0441\u0442\u0440\u043e\u0435\u043d\u0438\u044f \u043a\u0440\u0430\u0441\u0438\u0432\u043e\u0439 \u0432\u0438\u0437\u0443\u0430\u043b\u0438\u0437\u0430\u0446\u0438\u0438 \u0441\u0442\u0440\u0443\u043a\u0442\u0443\u0440\u044b \u043f\u0440\u043e\u0438\u0437\u0432\u043e\u043b\u044c\u043d\u043e\u0433\u043e \u043a\u0430\u0442\u0430\u043b\u043e\u0433\u0430. \n\u041d\u0430\u043f\u0440\u0438\u043c\u0435\u0440, \u0434\u043b\u044f \u044d\u0442\u043e\u0433\u043e \u043f\u0440\u043e\u0435\u043a\u0442\u0430, \u043e\u043d\u043e \u0433\u0435\u043d\u0435\u0440\u0438\u0440\u0443\u0435\u0442 \u0441\u043b\u0435\u0434\u0443\u044e\u0449\u0443\u044e \u0432\u0438\u0437\u0443\u0430\u043b\u0438\u0437\u0430\u0446\u0438\u044e:\n```\n\ud83d\udcc1 awesome-structure\n\u251c\u2500\u2500 \ud83d\udcc1 src\n\u2502 \u251c\u2500\u2500 \ud83d\udcc1 awesome_structure\n\u2502 \u2502 \u251c\u2500\u2500 \ud83d\udcc1 renderers\n\u2502 \u2502 \u2502 \u251c\u2500\u2500 \ud83d\udc0d __init__.py\n\u2502 \u2502 \u2502 \u251c\u2500\u2500 \ud83d\udc0d icons.py\n\u2502 \u2502 \u2502 \u251c\u2500\u2500 \ud83d\udc0d markdown.py\n\u2502 \u2502 \u2502 \u2514\u2500\u2500 \ud83d\udc0d terminal.py\n\u2502 \u2502 \u251c\u2500\u2500 \ud83d\udc0d __init__.py\n\u2502 \u2502 \u251c\u2500\u2500 \ud83d\udc0d cli.py\n\u2502 \u2502 \u2514\u2500\u2500 \ud83d\udc0d tree_builder.py\n\u2502 \u2514\u2500\u2500 \ud83d\udc0d __init__.py\n\u251c\u2500\u2500 \ud83d\udcc1 tests\n\u2502 \u251c\u2500\u2500 \ud83d\udcc1 test_renderers\n\u2502 \u2502 \u251c\u2500\u2500 \ud83d\udc0d test_markdown.py\n\u2502 \u2502 \u2514\u2500\u2500 \ud83d\udc0d test_terminal.py\n\u2502 \u251c\u2500\u2500 \ud83d\udc0d __init__.py\n\u2502 \u251c\u2500\u2500 \ud83d\udc0d conftest.py\n\u2502 \u251c\u2500\u2500 \ud83d\udc0d test_cli.py\n\u2502 \u2514\u2500\u2500 \ud83d\udc0d test_tree_builder.py\n\u251c\u2500\u2500 \ud83d\udcc4 .gitignore\n\u251c\u2500\u2500 \ud83d\udcc4 LICENSE\n\u251c\u2500\u2500 \ud83d\udcc4 poetry.lock\n\u251c\u2500\u2500 \u2699\ufe0f pyproject.toml\n\u2514\u2500\u2500 \ud83d\udcd6 README.md\n```\n### \u0423\u0441\u0442\u0430\u043d\u043e\u0432\u043a\u0430\n\n---\n\n\u041f\u0430\u043a\u0435\u0442 \u043e\u043f\u0443\u0431\u043b\u0438\u043a\u043e\u0432\u0430\u043d \u0432 PyPi: **[awesome-structure](https://pypi.org/project/awesome-structure/)**\n\n\u0412\u043e\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u0439\u0442\u0435\u0441\u044c \u0443\u0434\u043e\u0431\u043d\u044b\u043c \u0434\u043b\u044f \u0432\u0430\u0441 \u043c\u0435\u043d\u0435\u0434\u0436\u0435\u0440\u043e\u043c \u043f\u0430\u043a\u0435\u0442\u043e\u0432: \n**pip**\n```shell\npip install awesome-structure\n```\n\n**poetry**\n```shell\npoetry add awesome-structure\n```\n\n### \u0418\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u043d\u0438\u0435 \n\n---\n\u0412\u044b\u0437\u043e\u0432\u0438\u0442\u0435 \u0442\u0443 \u0441\u0430\u043c\u0443\u044e \u0437\u0430\u0432\u0435\u0442\u043d\u0443\u044e \u043a\u043e\u043c\u0430\u043d\u0434\u0443 ``admire`` \u0441 \u0443\u043a\u0430\u0437\u0430\u043d\u0438\u0435\u043c \u043f\u0430\u0440\u0430\u043c\u0435\u0442\u0440\u0430 \u043f\u0443\u0442\u0438 \u043a \u043a\u0430\u0442\u0430\u043b\u043e\u0433\u0443 \u0434\u043b\u044f \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u0438\u044f \u0443\u0434\u043e\u0432\u043e\u043b\u044c\u0441\u0442\u0432\u0438\u044f, \u0442\u0430\u043a:\n```shell\nawesome-structure admire \"[\u043f\u0443\u0442\u044c \u043a \u0432\u0430\u0448\u0435\u043c\u0443 \u043a\u0430\u0442\u0430\u043b\u043e\u0433\u0443]\"\n```\n\u0438\u043b\u0438 \u0441 \u044f\u0432\u043d\u044b\u043c \u043a\u0430\u0437\u0430\u043d\u0438\u0435\u043c \u043f\u0430\u0440\u0430\u043c\u0435\u0442\u0440\u0430 ``--path`` \u0442\u0430\u043a:\n```shell\nawesome-structure admire --path \"[\u043f\u0443\u0442\u044c \u043a \u0432\u0430\u0448\u0435\u043c\u0443 \u043a\u0430\u0442\u0430\u043b\u043e\u0433\u0443]\"\n```\n\n\u041f\u0440\u0438\u043c\u0435\u0440:\n```shell\nawesome-structure admire \"C:\\Program Files\"\n```\n\n**\u0414\u043b\u044f \u043a\u043e\u0440\u0440\u0435\u043a\u0442\u043d\u043e\u0439 \u0440\u0430\u0431\u043e\u0442\u044b, \u043d\u0430\u0441\u0442\u043e\u044f\u0442\u0435\u043b\u044c\u043d\u043e \u0440\u0435\u043a\u043e\u043c\u0435\u043d\u0434\u0443\u0435\u0442\u0441\u044f \u0437\u0430\u043a\u043b\u044e\u0447\u0430\u0442\u044c \u043f\u0443\u0442\u044c \u0432 \u043a\u0430\u0432\u044b\u0447\u043a\u0438 \"\".** \n\n\u0420\u0435\u0437\u0443\u043b\u044c\u0442\u0430\u0442 \u0431\u0443\u0434\u0435\u0442 \u0432\u044b\u0432\u0435\u0434\u0435\u043d \u0432 \u0442\u0435\u0440\u043c\u0438\u043d\u0430\u043b. \n\n\u0415\u0441\u043b\u0438 \u0432\u044b \u0436\u0435\u043b\u0430\u0435\u0442\u0435 \u043f\u043e\u043b\u0443\u0447\u0438\u0442\u044c \u0440\u0435\u0437\u0443\u043b\u044c\u0442\u0430\u0442 \u0432 \u0432\u0438\u0434\u0435 \u0444\u0430\u0439\u043b\u0430, \u0434\u043e\u0441\u0442\u0443\u043f\u043d\u043e \u0441\u043e\u0445\u0440\u0430\u043d\u0435\u043d\u0438\u0435 **markdown** \u0440\u0430\u0437\u043c\u0435\u0442\u043a\u0438 \u0432 \u0444\u0430\u0439\u043b _**awesome-structure.md**_. \n\u041f\u0440\u043e\u0441\u0442\u043e \u043f\u0440\u0438 \u0432\u044b\u0437\u043e\u0432\u0435 \u043a\u043e\u043c\u0430\u043d\u0434\u044b \u0443\u043a\u0430\u0436\u0438\u0442\u0435 \u0441\u043e\u043e\u0442\u0432\u0435\u0442\u0441\u0442\u0432\u0443\u044e\u0449\u0435\u0435 \u0437\u043d\u0430\u0447\u0435\u043d\u0438\u0435 \u0432 \u043f\u0430\u0440\u0430\u043c\u0435\u0442\u0440\u0435 ``mode`` \n```shell\nawesome-structure admire \"C:\\Program Files\" --mode markdown\n```\n\n\u0424\u0430\u0439\u043b \u0431\u0443\u0434\u0435\u0442 \u0441\u043e\u0445\u0440\u0430\u043d\u0451\u043d \u0432 \u0442\u043e\u043c \u043a\u0430\u0442\u0430\u043b\u043e\u0433\u0435, \u0434\u043b\u044f \u043a\u043e\u0442\u043e\u0440\u043e\u0433\u043e \u0441\u0442\u0440\u043e\u0438\u0442\u0441\u044f \u0432\u0438\u0437\u0443\u0430\u043b\u0438\u0437\u0430\u0446\u0438\u044f.\n\n\u041f\u043e \u0443\u043c\u043e\u043b\u0447\u0430\u043d\u0438\u044e, \u0432\u0441\u0435 \u0441\u043a\u0440\u044b\u0442\u044b\u0435 \u0444\u0430\u0439\u043b\u044b \u0438 \u043a\u0430\u0442\u0430\u043b\u043e\u0433\u0438 (\u0442\u0435, \u0447\u044c\u0451 \u043d\u0430\u0437\u0432\u0430\u043d\u0438\u0435 \u043d\u0430\u0447\u0438\u043d\u0430\u0435\u0442\u0441\u044f \u0441 \"**.**\") \u043d\u0435 \u043f\u043e\u043f\u0430\u0434\u0430\u044e\u0442 \u0432 \u0432\u044b\u0432\u043e\u0434 \u0440\u0435\u0437\u0443\u043b\u044c\u0442\u0430\u0442\u0430. \n\u041a \u043d\u0438\u043c \u043c\u043e\u0433\u0443\u0442 \u043e\u0442\u043d\u043e\u0441\u0438\u0442\u044c\u0441\u044f ``.env``, ``.gitignore`` \u0438 \u0442.\u0434.\n\u0415\u0441\u043b\u0438 \u0432\u044b \u0445\u043e\u0442\u0438\u0442\u0435 \u0432\u043a\u043b\u044e\u0447\u0438\u0442\u044c \u0432 \u0432\u044b\u0432\u043e\u0434 \u0441\u043a\u0440\u044b\u0442\u044b\u0435 \u043f\u0430\u043f\u043a\u0438 \u0438 \u0444\u0430\u0439\u043b\u044b, \u0434\u043e\u0431\u0430\u0432\u044c\u0442\u0435 \u043a \u043a\u043e\u043c\u0430\u043d\u0434\u0435 \u0444\u043b\u0430\u0433 ``--hidden``.\n```shell\nawesome-structure admire \"C:\\Program Files\" --hidden\n```\n\u0424\u043b\u0430\u0433\u0438 \u043c\u043e\u0436\u043d\u043e \u043a\u043e\u043c\u0431\u0438\u043d\u0438\u0440\u043e\u0432\u0430\u0442\u044c \u0438 \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c\u0441\u044f \u0441\u043e\u0432\u043c\u0435\u0441\u0442\u043d\u043e. \u041d\u0430\u043f\u0440\u0438\u043c\u0435\u0440:\n```shell\nawesome-structure admire \"C:\\Program Files\" --mode markdown --hidden\n```\n\u041f\u043e\u0440\u044f\u0434\u043e\u043a \u0441\u043b\u0435\u0434\u043e\u0432\u0430\u043d\u0438\u044f \u0444\u043b\u0430\u0433\u043e\u0432 \u043d\u0435 \u0432\u0430\u0436\u0435\u043d\n```shell\nawesome-structure admire \"C:\\Program Files\" --hidden --mode markdown \n```\n\n\n\n\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "\u0412\u0441\u0435\u0433\u043e \u043e\u0434\u043d\u0430 \u043a\u043e\u043c\u0430\u043d\u0434\u0430 \u0432 \u0442\u0435\u0440\u043c\u0438\u043d\u0430\u043b\u0435, \u043e\u0442\u0434\u0435\u043b\u044f\u044e\u0449\u0430\u044f \u0432\u0430\u0441 \u043e\u0442 \u043d\u0430\u0441\u043b\u0430\u0436\u0434\u0435\u043d\u0438\u044f \u043f\u0440\u0435\u043a\u0440\u0430\u0441\u043d\u043e\u0439 \u0441\u0442\u0440\u0443\u043a\u0442\u0443\u0440\u043e\u0439 \u0432\u0430\u0448\u0435\u0433\u043e \u043f\u0440\u043e\u0435\u043a\u0442\u0430 \ud83d\ude0c",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [
"cli",
" directory",
" tree",
" visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "41800df1a88235db5337d71a6666c626b89858c542dd335fcddd0d7e7991e6e6",
"md5": "a748b2d14dd393efc46de0e330acd0a7",
"sha256": "01fbbf904b93c9747d2bde4192955b00e1aeac68bfdf92daa6c42b5bdc1ae4e5"
},
"downloads": -1,
"filename": "awesome_structure-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a748b2d14dd393efc46de0e330acd0a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 9118,
"upload_time": "2025-07-13T15:56:58",
"upload_time_iso_8601": "2025-07-13T15:56:58.428281Z",
"url": "https://files.pythonhosted.org/packages/41/80/0df1a88235db5337d71a6666c626b89858c542dd335fcddd0d7e7991e6e6/awesome_structure-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "901e1cf461b69f8fc0c22628f1b8350d9abbde4933bd1f648dff11485d87f95c",
"md5": "b43ff08637b1f916ed0da65a25aacec4",
"sha256": "97c84bcc61ed050f81f40b9d5cef6f0561dc669a865037b7d2995a3b82cf39fa"
},
"downloads": -1,
"filename": "awesome_structure-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b43ff08637b1f916ed0da65a25aacec4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 6796,
"upload_time": "2025-07-13T15:56:59",
"upload_time_iso_8601": "2025-07-13T15:56:59.582726Z",
"url": "https://files.pythonhosted.org/packages/90/1e/1cf461b69f8fc0c22628f1b8350d9abbde4933bd1f648dff11485d87f95c/awesome_structure-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-13 15:56:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "awesome-structure"
}
