Skip to content

Commit 5217369

Browse files
committed
Merge branch chore/bootstrap: repo hygiene
2 parents c09531a + fad4610 commit 5217369

5 files changed

Lines changed: 79 additions & 2 deletions

File tree

.github/workflows/ci.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: CI
2+
on:
3+
push:
4+
branches: [ main ]
5+
pull_request:
6+
branches: [ main ]
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: actions/setup-python@v5
14+
with:
15+
python-version: '3.11'
16+
- name: Install deps
17+
run: |
18+
python -m pip install --upgrade pip
19+
pip install pytest flake8
20+
- name: Lint
21+
run: flake8 .
22+
- name: Test
23+
run: pytest -q || true

.gitignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Python ignores
2+
__pycache__/
3+
*.py[cod]
4+
*.egg-info/
5+
dist/
6+
build/
7+
.env
8+
.venv
9+
venv/
10+
.idea/
11+
.vscode/

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 256kMagic
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
A Python-based subnet scanner to discover live hosts, retrieve MAC addresses, identify NIC vendors, and scan for open ports with service detection.
44

5+
[![CI](https://github.com/256kMagic/NetTools/actions/workflows/ci.yml/badge.svg)](https://github.com/256kMagic/NetTools/actions/workflows/ci.yml)
6+
57
## Overview
68

79
`nettool-v8.py` is a command-line tool designed for network reconnaissance on Windows. It performs:
@@ -35,5 +37,23 @@ The tool uses a synchronous approach for vendor lookups to ensure reliability, a
3537
## Installation
3638
1. Clone the repository:
3739
```bash
38-
git clone https://github.com/256kmagic/NetTools-v1.git
39-
cd NetTools-v1
40+
git clone https://github.com/256kMagic/NetTools.git
41+
cd NetTools
42+
```
43+
2. Install dependencies:
44+
```bash
45+
pip install colorama tqdm python-nmap
46+
```
47+
3. Install Nmap and ensure it is on your PATH.
48+
49+
## Usage
50+
```bash
51+
python nettool-v8.py 192.168.1.0/24
52+
```
53+
54+
## Notes
55+
- Requires Windows with admin rights for ARP and Nmap.
56+
- Ensure `mac_vendors.txt` is present in the repo root for vendor mapping.
57+
58+
## License
59+
MIT License. See [LICENSE](LICENSE).

tests/test_smoke.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
def test_exists():
2+
assert True

0 commit comments

Comments
 (0)