Skip to main content

github仓库目录树生成

Project description

github_dir_tree

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

截图

serial_module_screenshot.jpg

待做

  • [x] 支持文件/目录描述
  • [x] 支持 gitingore 语法过滤文件,支持自动读取.gitignore过滤文件
  • [x] 自动增加/更新到README.md文件
  • [x] 支持文件/目录描述
  • [ ] 支持多个描述符匹配
  • [ ] 各种形式打印并输出到各类文件中
  • [ ] 生成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 为文件夹描述符

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for github-dir-tree, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size github_dir_tree-1.1.0-py3-none-any.whl (8.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size github dir tree-1.1.0.tar.gz (7.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page