Skip to content

scripts/build_directory_md.py: Add more ignores and ignores_exts #1047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 21 additions & 36 deletions scripts/build_directory_md.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python3
"""
This is a simple script that will scan through the current directory
and generate the corresponding DIRECTORY.md file, can also specify
Expand All @@ -7,63 +8,47 @@


# Target URL (master)
URL = "https://github.com/TheAlgorithms/Python/blob/master/"
BASE_URL = "https://github.com/TheAlgorithms/Python/blob/master/"


def tree(d, ignores, ignores_ext):
return _markdown(d, ignores, ignores_ext, 0)


def _markdown(parent, ignores, ignores_ext, depth):
out = ""
dirs, files = [], []
for i in os.listdir(parent):
full = os.path.join(parent, i)
name, ext = os.path.splitext(i)
if i not in ignores and ext not in ignores_ext:
if i[0] != "." and i not in ignores and ext not in ignores_ext:
if os.path.isfile(full):
# generate list
pre = parent.replace("./", "").replace(" ", "%20")
# replace all spaces to safe URL
child = i.replace(" ", "%20")
files.append((pre, child, name))
url = f"{BASE_URL}{parent.replace('./', '')}/{i}".replace(" ", "%20")
files.append((name.replace("_", " "), url))
else:
dirs.append(i)
# Sort files
files.sort(key=lambda e: e[2].lower())
for f in files:
pre, child, name = f
out += " " * depth + "* [" + name.replace("_", " ") + "](" + URL + pre + "/" + child + ")\n"
# Sort directories
dirs.sort()
for i in dirs:
dirs.append(i)
out = (
"\n".join(
f"{' ' * depth}* [{name}]({url})"
for name, url in sorted(files, key=lambda e: e[0].lower())
)
+ "\n"
)
for i in sorted(dirs):
full = os.path.join(parent, i)
i = i.replace("_", " ").title()
if depth == 0:
out += "## " + i + "\n"
out += f"## {i}\n"
else:
out += " " * depth + "* " + i + "\n"
out += _markdown(full, ignores, ignores_ext, depth+1)
out += f"{' ' * depth}* {i}\n"
out += _markdown(full, ignores, ignores_ext, depth + 1)
return out


# Specific files or folders with the given names will be ignored
ignores = [".vs",
".gitignore",
".git",
"scripts",
"__init__.py",
"requirements.txt",
".github"
]
ignores = "__init__.py __pycache__ requirements.txt scripts".split()

# Files with given entensions will be ignored
ignores_ext = [
".md",
".ipynb",
".png",
".jpg",
".yml"
]
ignores_ext = ".ini .json .jpg .md .png .pyc .txt .yml".split()


if __name__ == "__main__":
Expand Down