algorembrant commited on
Commit
fe16f4b
Β·
verified Β·
1 Parent(s): 2db20ba

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +64 -56
README.md CHANGED
@@ -1,56 +1,64 @@
1
- # filesystem-auditor
2
-
3
- ## Description
4
- `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.
5
-
6
- ![license](https://img.shields.io/badge/license-MIT-blue)
7
- ![reposize](https://img.shields.io/badge/reposize-29.6%20KB-brightgreen)
8
- ![last-commit](https://img.shields.io/badge/last--commit-2026--02--28-orange)
9
- ![language-python](https://img.shields.io/badge/language-Python-blue)
10
-
11
- ## System Overview
12
-
13
- ```mermaid
14
- graph TD
15
- A[Repository Path] --> B{Action}
16
- B -->|Structure Scan| C[scan_structure.py]
17
- B -->|Techstack Scan| D[scan_techstack.py]
18
- C --> E[STRUCTURE.md]
19
- D --> F[TECHSTACK.md]
20
- E --> G[Visual Documentation]
21
- F --> G
22
- ```
23
-
24
- ## Project Structure
25
-
26
- ```text
27
- filesystem-auditor (local)/
28
- β”œβ”€β”€ scan_structure.py
29
- └── scan_techstack.py
30
- ```
31
-
32
- ## Usage
33
- To audit your repository, run the scripts from the command line:
34
-
35
- ```powershell
36
- # Scan directory structure
37
- python scan_structure.py . --output STRUCTURE.md
38
-
39
- # Audit techstack (file types, counts, sizes)
40
- python scan_techstack.py . --output TECHSTACK.md
41
- ```
42
-
43
- ## BibTeX Citation
44
- ```bibtex
45
- @misc{albeos2026filesystemauditor,
46
- author = {Rembrant Oyangoren Albeos},
47
- title = {filesystem-auditor: High-performance repository structure and techstack scanner},
48
- year = {2026},
49
- publisher = {Hugging Face},
50
- journal = {Hugging Face Repository},
51
- howpublished = {\url{https://huggingface.co/algorembrant/filesystem-auditor/}}
52
- }
53
- ```
54
-
55
- ## Author
56
- Rembrant Oyangoren Albeos (2026)
 
 
 
 
 
 
 
 
 
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
+ ![license](https://img.shields.io/badge/license-MIT-blue)
15
+ ![reposize](https://img.shields.io/badge/reposize-29.6%20KB-brightgreen)
16
+ ![last-commit](https://img.shields.io/badge/last--commit-2026--02--28-orange)
17
+ ![language-python](https://img.shields.io/badge/language-Python-blue)
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)