{"id":14064735,"url":"https://github.com/thevickypedia/NetSec","last_synced_at":"2025-07-29T18:33:57.971Z","repository":{"id":82534493,"uuid":"399236638","full_name":"thevickypedia/NetSec","owner":"thevickypedia","description":"Python module to analyze devices connected to the router and alert accordingly.","archived":false,"fork":false,"pushed_at":"2023-08-16T03:54:12.000Z","size":420,"stargazers_count":19,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-12-01T21:11:59.493Z","etag":null,"topics":["allowlist","denylist","firewall","netgear","netsec","network-security","router-monitor","wifi"],"latest_commit_sha":null,"homepage":"https://thevickypedia.github.io/netscan/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thevickypedia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-23T20:16:13.000Z","updated_at":"2024-10-18T04:45:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"f5e959da-34af-4daf-a61a-7478c8c42664","html_url":"https://github.com/thevickypedia/NetSec","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thevickypedia%2FNetSec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thevickypedia%2FNetSec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thevickypedia%2FNetSec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thevickypedia%2FNetSec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thevickypedia","download_url":"https://codeload.github.com/thevickypedia/NetSec/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228040830,"owners_count":17860211,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["allowlist","denylist","firewall","netgear","netsec","network-security","router-monitor","wifi"],"created_at":"2024-08-13T07:04:02.782Z","updated_at":"2024-12-04T03:31:25.029Z","avatar_url":"https://github.com/thevickypedia.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"**Platform Supported**\n\n![Generic badge](https://img.shields.io/badge/Platform-Linux|MacOS|Windows-1f425f.svg)\n\n![Python](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)\n\n**Deployments**\n\n[![pypi](https://github.com/thevickypedia/NetSec/actions/workflows/python-publish.yml/badge.svg)](https://github.com/thevickypedia/NetSec/actions/workflows/python-publish.yml)\n[![pages-build-deployment](https://github.com/thevickypedia/NetSec/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/thevickypedia/NetSec/actions/workflows/pages/pages-build-deployment)\n\n[![Pypi-format](https://img.shields.io/pypi/format/NetSec)](https://pypi.org/project/NetSec/#files)\n[![Pypi-status](https://img.shields.io/pypi/status/NetSec)](https://pypi.org/project/NetSec)\n\n# NetSec (Network Security)\nNetSec is a tool to analyze devices connecting to the router and alert accordingly when a new device is connected.\n\nThis app can display and store intruders' IP address, MAC address, and Block the device.\n\n\u003e Blocking device feature is currently available only for `Netgear` router users.\n\n## Kick off\n\n**Install**\n```shell\npython3 -m pip install NetSec\n```\n\n**Initiate**\n```python\nfrom netsec import network_monitor, SupportedModules\n\nif __name__ == '__main__':\n    # SupportedModules.att  # for AT\u0026T users\n    # SupportedModules.netgear  # for any network using Netgear router\n    network_monitor(module=SupportedModules.att, init=True)  # Create snapshot\n    network_monitor(module=SupportedModules.att, init=False)  # Scan for threats and alert\n```\n\n\u003e Notifications will not repeat within an hour.\n\n## ENV Variables\nEnvironment variables are loaded from a `.env` file.\n\n- **ROUTER_PASS** - Router password. _Only for `Netgear` users._\n- **GMAIL_USER** - Gmail account username to send and email.\n- **GMAIL_PASS** - Gmail account password to send and email.\n- **RECIPIENT** - Email address to which `NetSec` alerts should be sent.\n- **PHONE** - To send an SMS notification - Example: `1234567890`\n\n## Coding Standards\nDocstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) \u003cbr\u003e\nStyling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) \u003cbr\u003e\nClean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and \n[`isort`](https://pycqa.github.io/isort/)\n\n## [Release Notes](https://github.com/thevickypedia/NetSec/blob/master/release_notes.rst)\n**Requirement**\n```shell\npython -m pip install gitverse\n```\n\n**Usage**\n```shell\ngitverse-release reverse -f release_notes.rst -t 'Release Notes'\n```\n\n## Linting\n`PreCommit` will ensure linting, and the doc creation are run on every commit.\n\n**Requirement**\n```shell\npip install sphinx==5.1.1 pre-commit recommonmark\n```\n\n**Usage**\n```shell\npre-commit run --all-files\n```\n\n## Pypi Package\n[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)](https://packaging.python.org/tutorials/packaging-projects/)\n\n[https://pypi.org/project/NetSec/](https://pypi.org/project/NetSec/)\n\n## Runbook\n[![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)\n\n[https://thevickypedia.github.io/NetSec/](https://thevickypedia.github.io/NetSec/)\n\n## License \u0026 copyright\n\n\u0026copy; Vignesh Rao, NetSec\n\nLicensed under the [MIT License](https://github.com/thevickypedia/NetSec/blob/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthevickypedia%2FNetSec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthevickypedia%2FNetSec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthevickypedia%2FNetSec/lists"}