Repository navigation
docs: add missing python script readmes and fix sequence diagrams - #129
Closed
bhushan4work wants to merge 1 commit into
Closed
bhushan4work wants to merge 1 commit into
bhushan4work wants to merge 1 commit into
Conversation
…amandewatnitrr#34) - add monitor-mode-toggle.md and netwwork_scanner_tutorial.md covering usage, prerequisites, inputs/outputs, code flow and a mermaid sequence diagram - close the unclosed ```mermaid fences in 12 script readmes so the sequence diagrams render instead of swallowing the rest of the file - restructure arp_spoof_detector.md (close bash fence, fence the diagram as mermaid, correct script name, include the root check branch) - add a sequence diagram to bettercap_arp_spoofing_script_auto.md - drop a stray trailing fence in mitm_attack_automation_readme.md
|
@bhushan4work is attempting to deploy a commit to the amandewatnitrr's projects Team on Vercel. A member of the Team first needs to authorize it. |
Owner
|
I am personally working on this so, for now I will not merge the MR. Sorry for inconvenience. |
Contributor
Author
|
works , thanks for the followup , I ll work on other issues . |
There was a problem hiding this comment.
🟡 Changes recommended
The new arp_spoof_detector.md sequence diagram depicts the id -u root check as a working gate, contradicting the same file's own note that the check is broken because stdout is None.
1 open issue
What changed in this PR
This documentation PR fulfills issue #34 by ensuring every Python script under python-scripts/ has a companion README with usage details, a code walkthrough, and a valid Mermaid sequence diagram. It fills coverage gaps and repairs rendering defects so the diagrams and code fences display correctly on GitHub. The changes are documentation-only — no Python logic is modified.
Changes:
- Added two new READMEs (
monitor-mode-toggle.md,netwwork_scanner_tutorial.md) and a new sequence diagram section forbettercap_arp_spoofing_script_auto.md. - Repaired unclosed/orphaned code fences across many existing READMEs so Mermaid and code blocks render (adding closing ``` fences, removing one stray trailing fence).
- Corrected the run command in
arp_spoof_detector.md(arp_detector.py→arp_spoof_detector.py) and expanded its diagram to include the root check.
| File | Description |
|---|---|
| python-scripts/netwwork_scanner_tutorial.md | New README; accurately documents the minimal Scapy ARP scan demo and its flow. |
| python-scripts/monitor-mode-toggle.md | New README; diagram matches the script's mode-toggle logic and error branches. |
| python-scripts/arp_spoof_detector.md | Fixes run command, adds mermaid fence and a root-check branch to the diagram. |
| python-scripts/bettercap_arp_spoofing_script_auto.md | Adds a code-flow sequence diagram consistent with the script. |
| python-scripts/mitm_attack_automation_readme.md | Removes a stray trailing code fence, rebalancing the file. |
| python-scripts/wpa2_dictionary_attack.md | Adds missing closing fence for the Mermaid diagram. |
| python-scripts/wpa_wps_hack.md | Adds missing closing fence for the Mermaid diagram. |
| python-scripts/wordlist_generator.md | Adds missing closing fence for the Mermaid diagram. |
| python-scripts/wep_wifi_hacking.md | Adds missing closing fence for the Mermaid diagram. |
| python-scripts/remote_collect_via_ssh.md | Adds missing closing fence for the Mermaid diagram. |
| python-scripts/portscanner_test.md | Adds missing closing fence for the Mermaid diagram. |
| python-scripts/network_scanner.md | Adds missing closing fence for the Mermaid diagram. |
| python-scripts/mitm_attack_automator.md | Adds missing closing fence for the Mermaid diagram. |
| python-scripts/ids_probe.md | Adds missing closing fence for the Mermaid diagram. |
| python-scripts/https_data_fetcher_bettercap.md | Adds missing closing fence for the Mermaid diagram. |
| python-scripts/deauth_attack.md | Adds missing closing fence for the Mermaid diagram. |
| python-scripts/async_port_scanner.md | Adds missing closing fence for the Mermaid diagram. |
Review effort: Balanced
Comment on lines
+39
to
+41
| Script->>OS: Root check with id -u | ||
| alt Not running as root | ||
| Script->>User: Print root-privilege error and exit (1) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
description
monitor_mode_toggle.pyandnetwwork_scanner_tutorial.py.arp_spoof_detector.md.verification
wordlist_generator.pyin google colab and verified that it generated 50 entries.related issues
screenshots / videos