{"id":29260063,"url":"https://github.com/a-jean-andreasian/the-directory-scanner","last_synced_at":"2026-02-27T14:08:24.675Z","repository":{"id":221256833,"uuid":"753872450","full_name":"a-jean-andreasian/the-directory-scanner","owner":"a-jean-andreasian","description":"A Python lib which scans the directory structures and generates a comprehensive list of files and folders. It provides a convenient way to recursively traverse directories, ignoring specific files and folders specified by the user.","archived":false,"fork":false,"pushed_at":"2025-03-22T13:02:01.000Z","size":233,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-14T09:29:18.079Z","etag":null,"topics":["developer-tools","development","pypi-package","python","repository-management"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/a-jean-andreasian.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.rst","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-02-07T00:13:01.000Z","updated_at":"2025-10-10T07:37:58.000Z","dependencies_parsed_at":"2024-11-05T09:18:50.679Z","dependency_job_id":"ee4af901-5f64-402c-a9f5-be49d0c7b61b","html_url":"https://github.com/a-jean-andreasian/the-directory-scanner","commit_stats":null,"previous_names":["armen-jean-andreasian/directory-scanner","free-apps-for-all/the-directory-scanner","armen-jean-andreasian/the-directory-scanner","a-jean-andreasian/the-directory-scanner"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/a-jean-andreasian/the-directory-scanner","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-jean-andreasian%2Fthe-directory-scanner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-jean-andreasian%2Fthe-directory-scanner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-jean-andreasian%2Fthe-directory-scanner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-jean-andreasian%2Fthe-directory-scanner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/a-jean-andreasian","download_url":"https://codeload.github.com/a-jean-andreasian/the-directory-scanner/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-jean-andreasian%2Fthe-directory-scanner/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29899045,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T12:09:13.686Z","status":"ssl_error","status_checked_at":"2026-02-27T12:09:13.282Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["developer-tools","development","pypi-package","python","repository-management"],"created_at":"2025-07-04T07:07:28.119Z","updated_at":"2026-02-27T14:08:24.661Z","avatar_url":"https://github.com/a-jean-andreasian.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## The Directory Scanner\n\nThe Directory Scanner is a Python library designed to simplify the process of scanning directory structures and generating a comprehensive list of files and folders. It provides a convenient way to recursively traverse directories, ignoring specific files and folders specified by the user.\n\n![](.github/cover.jpg)\n### Features:\n- Recursively scan directories and subdirectories to generate a structured list of files and folders.\n- Exclude specific files and folders from the scan using an ignore list.\n- Supports customization of the output format to suit different needs.\n\n### Usage:\n1. Install the library using pip:\n    ```\n    pip install the-directory-scanner\n    ```\n\n2. Import the `scan_directory` function from the library and use it to scan a directory:\n    ```python\n   from the_directory_scanner import scan_directory\n   \n   scan_result = scan_directory(directory=\".\", output_file_name=\"directory_structure.txt\",\n                                ignored_items=('.git', '.idea', 'venv', '__pycache__',))\n    ```\n3. Access the generated directory structure in the output file (`directory_structure.txt` in this example) to view the results.\n\n4. If you wish to modify the structure, import `prettify_structure` function and provide the path to generated file:\n   ```python\n   from the_directory_scanner import scan_directory, prettify_structure\n   \n   scan_result = scan_directory(directory=\".\", output_file_name=\"directory_structure.txt\",\n                                ignored_items=('.git', '.idea', 'venv', '__pycache__',))\n   \n   prettify_structure(output_file=scan_result, spaces_to_trim=4, lines_to_trim=1)\n   ```\n   \n---\nOutput example `directory_structure.txt`:\n```\ndirectory_structure.txt\nLICENSE.rst\nREADME.md\nsetup.py\nusage.py\ndirectory_scanner/\n    directory_structure.txt\n    main.py\n    __init__.py\n```\n---\n\n### About:\nThe Directory Scanner library aims to simplify directory scanning tasks by providing a flexible and easy-to-use interface. Whether you need to generate a directory structure for documentation, analysis, or any other purpose, this library offers a convenient solution.\n\n### Links:\n- [GitHub Repository](https://github.com/Armen-Jean-Andreasian/the-directory-scanner)\n- [PyPI Package](https://pypi.org/project/the-directory-scanner/)\n\n---","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-jean-andreasian%2Fthe-directory-scanner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fa-jean-andreasian%2Fthe-directory-scanner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-jean-andreasian%2Fthe-directory-scanner/lists"}