github仓库目录树生成
Project description
github_dir_tree
自动读取文件/文件夹描述, 生成 markdown 形式的项目结构树
截图
待做
- 支持文件/目录描述
- 支持
gitingore语法过滤文件,支持自动读取.gitignore过滤文件 - 自动增加/更新到
README.md文件 - 支持文件/目录描述
- 支持多个描述符匹配
- 各种形式打印并输出到各类文件中
- 生成exe
- 重构读取配置文件和获取标准输入的代码
安装
- pip:
pip install pip install github_dir_tree
使用
- cmd:
python -m github_dir_tree.main [文件夹路径]
注意
- 第一次使用时会自动在目标文件夹下生成
.github_dir_tree配置文件, 你可以在配置文件里面修改配置 - 自动读取
.gitignore文件并自动过滤 - 默认
.dir_description为文件夹描述符
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
github dir tree-1.1.0.tar.gz
(7.4 kB
view details)
Built Distribution
File details
Details for the file github dir tree-1.1.0.tar.gz.
File metadata
- Download URL: github dir tree-1.1.0.tar.gz
- Upload date:
- Size: 7.4 kB
- Tags: Source
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1b3638a6fbef8ca4a2e1d91c31b8fc2417395a18060845517f597a96fd3b7f1e |
|
| MD5 | 83f821bba3e59486c954a15cc8e7e446 |
|
| BLAKE2b-256 | 77cff1889ac644119b58855ed92bb357cc0f0bdf603b8360686ce3353fc1cc83 |
File details
Details for the file github_dir_tree-1.1.0-py3-none-any.whl.
File metadata
- Download URL: github_dir_tree-1.1.0-py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 3
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 68fcde80f7041b58320e55d808677e8e274003bbaa5574b3185c1a83d3af5882 |
|
| MD5 | 991c76fd1a1fe711e596212e4a9400a3 |
|
| BLAKE2b-256 | e7febea08ab2820969c992c894011c8da79e3de021d2f137eacdabbf9ee0715f |
