Skip to main content

github_dir_tree

自动读取文件/文件夹描述, 生成 markdown 形式的项目结构树

截图

serial_module_screenshot.jpg

待做

  • 支持文件/目录描述
  • 支持 gitingore 语法过滤文件,支持自动读取.gitignore过滤文件
  • 自动增加/更新到README.md文件
  • 支持文件/目录描述
  • 支持多个描述符匹配
  • 各种形式打印并输出到各类文件中
  • 生成exe
  • 重构读取配置文件和获取标准输入的代码

安装

  • pip: pip install pip install github_dir_tree

使用

  • cmd: python -m github_dir_tree.main [文件夹路径]

注意

  1. 第一次使用时会自动在目标文件夹下生成.github_dir_tree 配置文件, 你可以在配置文件里面修改配置
  2. 自动读取.gitignore文件并自动过滤
  3. 默认 .dir_description 为文件夹描述符

Metadata

Release files for github-dir-tree 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for github-dir-tree 1.1.0
File Size Uploaded
github dir tree-1.1.0.tar.gz 7.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for github-dir-tree 1.1.0
File Interpreter ABI Platform
github_dir_tree-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 15.5 kB

Release files / github dir tree-1.1.0.tar.gz

Download URL github dir tree-1.1.0.tar.gz
Size 7.4 kB
Tags Source
SHA-256 checksum
How to use checksums
1b3638a6fbef8ca4a2e1d91c31b8fc2417395a18060845517f597a96fd3b7f1e
BLAKE2b-256 checksum
How to use checksums
77cff1889ac644119b58855ed92bb357cc0f0bdf603b8360686ce3353fc1cc83
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.6.8

Release files / github_dir_tree-1.1.0-py3-none-any.whl

Download URL github_dir_tree-1.1.0-py3-none-any.whl
Size 8.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
68fcde80f7041b58320e55d808677e8e274003bbaa5574b3185c1a83d3af5882
BLAKE2b-256 checksum
How to use checksums
e7febea08ab2820969c992c894011c8da79e3de021d2f137eacdabbf9ee0715f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.6.8

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page