`repo2markdown`¶

Module Contents¶

Functions¶

`should_include_file`(file_path)
`generate_tree_structure`(→ str)
`get_readme_content`(→ str)
`get_imported_modules`(→ list)
`write_imports_section`(root_dir)
`write_file_contents`(root_dir)
`main`()

Attributes¶

`ROOT_DIR`
`OUTPUT_FILE`
`INCLUDE_EXTENSIONS`
`SKIP_DIRS`
`INDENT`

repo2markdown.ROOT_DIR¶

repo2markdown.OUTPUT_FILE¶

repo2markdown.INCLUDE_EXTENSIONS¶

repo2markdown.SKIP_DIRS¶

repo2markdown.INDENT = ' '¶

repo2markdown.should_include_file(file_path: pathlib.Path)¶

repo2markdown.generate_tree_structure(root: pathlib.Path) → str¶

repo2markdown.get_readme_content(root: pathlib.Path) → str¶

repo2markdown.get_imported_modules(file_path: pathlib.Path) → list¶

repo2markdown.write_imports_section(root_dir: pathlib.Path)¶

repo2markdown.write_file_contents(root_dir: pathlib.Path)¶

repo2markdown.main()¶