Update README.md
Browse files
README.md
CHANGED
|
@@ -1,56 +1,64 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
##
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
```
|
| 31 |
-
|
| 32 |
-
##
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: mit
|
| 3 |
+
language:
|
| 4 |
+
- py
|
| 5 |
+
tags:
|
| 6 |
+
- filesystem
|
| 7 |
+
- auditor
|
| 8 |
+
---
|
| 9 |
+
# filesystem-auditor
|
| 10 |
+
|
| 11 |
+
## Description
|
| 12 |
+
`filesystem-auditor` is a pair of high-performance Python scripts designed to scan and analyze repository structures and tech stacks. It handles massive filesystems efficiently using `os.scandir` and provides detailed Markdown-formatted audits of file types, counts, and sizes. Look at `example_output\` forlder for examples.
|
| 13 |
+
|
| 14 |
+

|
| 15 |
+

|
| 16 |
+

|
| 17 |
+

|
| 18 |
+
|
| 19 |
+
## System Overview
|
| 20 |
+
|
| 21 |
+
```mermaid
|
| 22 |
+
graph TD
|
| 23 |
+
A[Repository Path] --> B{Action}
|
| 24 |
+
B -->|Structure Scan| C[scan_structure.py]
|
| 25 |
+
B -->|Techstack Scan| D[scan_techstack.py]
|
| 26 |
+
C --> E[STRUCTURE.md]
|
| 27 |
+
D --> F[TECHSTACK.md]
|
| 28 |
+
E --> G[Visual Documentation]
|
| 29 |
+
F --> G
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
## Project Structure
|
| 33 |
+
|
| 34 |
+
```text
|
| 35 |
+
filesystem-auditor (local)/
|
| 36 |
+
βββ scan_structure.py
|
| 37 |
+
βββ scan_techstack.py
|
| 38 |
+
```
|
| 39 |
+
|
| 40 |
+
## Usage
|
| 41 |
+
To audit your repository, run the scripts from the command line:
|
| 42 |
+
|
| 43 |
+
```powershell
|
| 44 |
+
# Scan directory structure
|
| 45 |
+
python scan_structure.py . --output STRUCTURE.md
|
| 46 |
+
|
| 47 |
+
# Audit techstack (file types, counts, sizes)
|
| 48 |
+
python scan_techstack.py . --output TECHSTACK.md
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
+
## BibTeX Citation
|
| 52 |
+
```bibtex
|
| 53 |
+
@misc{albeos2026filesystemauditor,
|
| 54 |
+
author = {Rembrant Oyangoren Albeos},
|
| 55 |
+
title = {filesystem-auditor: High-performance repository structure and techstack scanner},
|
| 56 |
+
year = {2026},
|
| 57 |
+
publisher = {Hugging Face},
|
| 58 |
+
journal = {Hugging Face Repository},
|
| 59 |
+
howpublished = {\url{https://huggingface.co/algorembrant/filesystem-auditor/}}
|
| 60 |
+
}
|
| 61 |
+
```
|
| 62 |
+
|
| 63 |
+
## Author
|
| 64 |
+
Rembrant Oyangoren Albeos (2026)
|