{"id":18576708,"url":"https://github.com/njanakiev/folderstats","last_synced_at":"2025-08-20T08:31:52.906Z","repository":{"id":45073724,"uuid":"162815086","full_name":"njanakiev/folderstats","owner":"njanakiev","description":"Python module that collects detailed statistics from a folder structure","archived":false,"fork":false,"pushed_at":"2022-11-22T19:49:34.000Z","size":540,"stargazers_count":69,"open_issues_count":3,"forks_count":28,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-05-29T05:49:14.298Z","etag":null,"topics":["data-analysis","filesystem","pandas","python","statistics"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/njanakiev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://www.paypal.me/njanakiev"]}},"created_at":"2018-12-22T13:49:19.000Z","updated_at":"2025-02-06T12:14:00.000Z","dependencies_parsed_at":"2023-01-22T03:17:04.258Z","dependency_job_id":null,"html_url":"https://github.com/njanakiev/folderstats","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/njanakiev/folderstats","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/njanakiev%2Ffolderstats","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/njanakiev%2Ffolderstats/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/njanakiev%2Ffolderstats/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/njanakiev%2Ffolderstats/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/njanakiev","download_url":"https://codeload.github.com/njanakiev/folderstats/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/njanakiev%2Ffolderstats/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271287619,"owners_count":24733424,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-20T02:00:09.606Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["data-analysis","filesystem","pandas","python","statistics"],"created_at":"2024-11-06T23:26:09.415Z","updated_at":"2025-08-20T08:31:52.648Z","avatar_url":"https://github.com/njanakiev.png","language":"Python","readme":"# folderstats\n\n[![](https://img.shields.io/pypi/v/folderstats.svg)](https://pypi.python.org/pypi/folderstats)\n\nThis is a python module and command-line interface that creates statistics from a folder structure. It returns a [Pandas](http://pandas.pydata.org/) dataframe from the folders and files from a selected folder.\n\n![Folder Structure Graph](folder_structure.png)\n\n# Installation\n\n```bash\npip install folderstats\n```\n\n# Usage\n\nTo get statistics of a folder structure as a Pandas dataframe in Python you can type:\n\n```python\nimport folderstats  \ndf = folderstats.folderstats(\n    '.', hash_name='md5',\n    exclude=[\"tests\", \"venv\", \"__pycache__\"],\n    ignore_hidden=True)\ndf\n```\n\n| path | name | extension | size | atime | mtime | ctime | folder | num_files | depth | uid | md5 |\n| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |\n| ./folder_structure.png | folder_structure | png | 525239 | 2022-01-10 16:08:32 | 2020-11-22 19:38:03 | 2020-11-22 19:38:03 | False |     | 0   | 1000 | a3cac43de8dd5fc33d7bede1bb1849de |\n| ./requirements.txt | requirements | txt | 14  | 2022-01-10 18:37:52 | 2022-01-08 17:29:52 | 2022-01-08 17:29:52 | False |     | 0   | 1000 | d8e272adf08f0389ef08be879d851df8 |\n| ./requirements-dev.txt | requirements-dev | txt | 33  | 2022-01-10 14:14:50 | 2022-01-08 17:54:50 | 2022-01-08 17:54:50 | False |     | 0   | 1000 | 42c7e7d9bc4620c2c7a12e6bbf8120bb |\n| ./README.md | README | md  | 3909 | 2022-01-10 18:37:52 | 2022-01-10 18:37:34 | 2022-01-10 18:37:34 | False |     | 0   | 1000 | 4339e186a35d77689419e996ee3998dc |\n| ./folderstats/\\_\\_main\\_\\_.py | \\_\\_main\\_\\_ | py  | 3313 | 2022-01-10 18:06:03 | 2022-01-10 18:05:58 | 2022-01-10 18:05:58 | False |     | 1   | 1000 | 62652872e08be115495aaf6e9f3a239a |\n| ./folderstats/\\_\\_init\\_\\_.py | \\_\\_init\\_\\_ | py  | 4556 | 2022-01-10 18:05:12 | 2022-01-10 18:04:56 | 2022-01-10 18:04:56 | False |     | 1   | 1000 | f0c8eb98713ddec7a4812a1471384296 |\n| ./folderstats | folderstats |     | 7869 | 2022-01-10 17:10:15 | 2022-01-10 17:10:15 | 2022-01-10 17:10:15 | True | 2.0 | 1   | 1000 |     |\n| ./LICENSE | LICENSE |     | 1073 | 2022-01-10 16:08:38 | 2020-11-22 19:38:03 | 2020-11-22 19:38:03 | False |     | 0   | 1000 | 1232cbd9eced47e27816f69740ad479d |\n| ./setup.py | setup | py  | 1925 | 2022-01-10 16:29:32 | 2020-11-22 19:38:03 | 2020-11-22 19:38:03 | False |     | 0   | 1000 | 01d39c60a0b41e6c928a6d3df6085d63 |\n| .   | .   |     | 544158 | 2022-01-10 18:37:00 | 2022-01-10 18:37:00 | 2022-01-10 18:37:00 | True | 8.0 | 0   | 1000 |     |\n\nYou can use the same functionality as a command-line interface which can generate files (CSV or JSON) or print the statistics directly into the command line:\n\n```bash\nfolderstats . -c md5 -i -o stats.csv\n```\n\nIn order to see the other available arguments, type:\n\n```bash\nfolderstats --help\n```\n\n```\nusage: folderstats [-h] [-o OUTPUT_FILEPATH] [-c HASH_NAME] [-a] [-m] [-i]\n                   [-p] [-e EXCLUDE] [-f FILTER_EXTENSION] [-l] [-v]\n                   folderpath\n\nCreates statistics from a folder structure\n\npositional arguments:\n  folderpath            input folder path\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -o OUTPUT_FILEPATH    output filepath, CSV and JSON supported\n  -c HASH_NAME          hash function for checksum\n  -a                    add absolute path column\n  -m                    store timestamps with microseconds\n  -i                    ignore hidden files and folders, Linux and Unix only\n  -p                    Add index and parent index\n  -e EXCLUDE, --exclude EXCLUDE\n                        Exclude files and folders by name\n  -f FILTER_EXTENSION, --filter-extension FILTER_EXTENSION\n                        Filter files by extension\n  -l, --follow-links    Follow symbolic and hard links\n  -v                    verbose console output\n```\n\n# Testing\n\nPrepare dev environment with:\n\n```bash\n# Create virtual environement\npython -m venv ./venv\n\n# Install dependencies\npip install -r requirements-dev.txt\npip install -r requirements.txt\n\n# Activate virtual environment\nsource venv/bin/activate\n```\n\nTo run unit tests, type:\n\n```bash\npytest -v\n```\n\n# License\n\nThis project is licensed under the MIT license. See the [LICENSE](LICENSE) for details.\n","funding_links":["https://www.paypal.me/njanakiev"],"categories":["Filesystems"],"sub_categories":["Books"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnjanakiev%2Ffolderstats","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnjanakiev%2Ffolderstats","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnjanakiev%2Ffolderstats/lists"}