-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Restructure code to improve speed and usability Update README.md, docs and requirements.txt Remove Dockerfile
- Loading branch information
1 parent
2b74cae
commit f739a98
Showing
41 changed files
with
2,101 additions
and
1,567 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
.env | ||
*.yaml | ||
*.json | ||
.idea | ||
venv | ||
__pycache__ | ||
build | ||
__pycache__/ | ||
_build/ | ||
fileio |
This file contains 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
This file was deleted.
Oops, something went wrong.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,43 @@ | ||
# NetScan | ||
Network Scanner to analyze devices connecting to the router and alert accordingly. | ||
|
||
NetScan displays the connected devices, Wi-Fi signal info, speed, etc. | ||
|
||
This app can display intruders IP addresses, MAC addresses, and lets the user Ping the device, and even Block user from | ||
Wi-Fi. | ||
This app can display intruders' IP addresses, MAC addresses, and lets the user Ping the device, and even Block the device. | ||
|
||
Block IP Address feature helps the user to remove the specified connections and block the specific IP address. | ||
|
||
### Docker Setup: | ||
> Blocking device feature is currently available only for `Netgear` router users. | ||
## Coding Standards | ||
Docstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) <br> | ||
Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br> | ||
Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and | ||
[`isort`](https://pycqa.github.io/isort/) | ||
|
||
## [Release Notes](https://github.com/thevickypedia/netscan/blob/master/release_notes.rst) | ||
**Requirement** | ||
```shell | ||
python -m pip install changelog-generator | ||
``` | ||
|
||
**Usage** | ||
```shell | ||
changelog reverse -f release_notes.rst -t 'Release Notes' | ||
``` | ||
|
||
###### Commands: | ||
- `docker build --progress plain -t netscan .` | ||
- `docker run netscan` | ||
## Linting | ||
`PreCommit` will ensure linting, and the doc creation are run on every commit. | ||
|
||
[Additional options that can be added to the `docker build` command.](https://docs.docker.com/engine/reference/commandline/build/#options) | ||
**Requirement** | ||
```shell | ||
pip install sphinx==5.1.1 pre-commit recommonmark | ||
``` | ||
|
||
###### [Reference](https://github.com/MatMaul/pynetgear) | ||
**Usage** | ||
```shell | ||
pre-commit run --all-files | ||
``` | ||
|
||
###### [Runbook](https://thevickypedia.github.io/netscan/) | ||
## Runbook | ||
[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html) | ||
|
||
###### [Repository](https://github.com/thevickypedia/netscan) | ||
[https://thevickypedia.github.io/netscan/](https://thevickypedia.github.io/netscan/) |
Oops, something went wrong.