| Name | NetSec JSON |
| Version |
0.9.1
JSON |
| download |
| home_page | |
| Summary | Python module to analyze devices connected to the router and alert accordingly. |
| upload_time | 2023-08-16 03:54:45 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2020 Vignesh Rao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
netsec
network-security
lan
wlan
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
**Platform Supported**
**Deployments**
[](https://github.com/thevickypedia/NetSec/actions/workflows/python-publish.yml)
[](https://github.com/thevickypedia/NetSec/actions/workflows/pages/pages-build-deployment)
[](https://pypi.org/project/NetSec/#files)
[](https://pypi.org/project/NetSec)
# NetSec (Network Security)
NetSec is a tool to analyze devices connecting to the router and alert accordingly when a new device is connected.
This app can display and store intruders' IP address, MAC address, and Block the device.
> Blocking device feature is currently available only for `Netgear` router users.
## Kick off
**Install**
```shell
python3 -m pip install NetSec
```
**Initiate**
```python
from netsec import network_monitor, SupportedModules
if __name__ == '__main__':
# SupportedModules.att # for AT&T users
# SupportedModules.netgear # for any network using Netgear router
network_monitor(module=SupportedModules.att, init=True) # Create snapshot
network_monitor(module=SupportedModules.att, init=False) # Scan for threats and alert
```
> Notifications will not repeat within an hour.
## ENV Variables
Environment variables are loaded from a `.env` file.
- **ROUTER_PASS** - Router password. _Only for `Netgear` users._
- **GMAIL_USER** - Gmail account username to send and email.
- **GMAIL_PASS** - Gmail account password to send and email.
- **RECIPIENT** - Email address to which `NetSec` alerts should be sent.
- **PHONE** - To send an SMS notification - Example: `1234567890`
## 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/NetSec/blob/master/release_notes.rst)
**Requirement**
```shell
python -m pip install gitverse
```
**Usage**
```shell
gitverse-release reverse -f release_notes.rst -t 'Release Notes'
```
## Linting
`PreCommit` will ensure linting, and the doc creation are run on every commit.
**Requirement**
```shell
pip install sphinx==5.1.1 pre-commit recommonmark
```
**Usage**
```shell
pre-commit run --all-files
```
## Pypi Package
[](https://packaging.python.org/tutorials/packaging-projects/)
[https://pypi.org/project/NetSec/](https://pypi.org/project/NetSec/)
## Runbook
[](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)
[https://thevickypedia.github.io/NetSec/](https://thevickypedia.github.io/NetSec/)
## License & copyright
© Vignesh Rao, NetSec
Licensed under the [MIT License](https://github.com/thevickypedia/NetSec/blob/main/LICENSE)
Raw data
{
"_id": null,
"home_page": "",
"name": "NetSec",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "NetSec,network-security,lan,wlan",
"author": "",
"author_email": "Vignesh Sivanandha Rao <svignesh1793@gmail.com>",
"download_url": "",
"platform": null,
"description": "**Platform Supported**\n\n\n\n\n\n**Deployments**\n\n[](https://github.com/thevickypedia/NetSec/actions/workflows/python-publish.yml)\n[](https://github.com/thevickypedia/NetSec/actions/workflows/pages/pages-build-deployment)\n\n[](https://pypi.org/project/NetSec/#files)\n[](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> 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&T 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> 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) <br>\nStyling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>\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[](https://packaging.python.org/tutorials/packaging-projects/)\n\n[https://pypi.org/project/NetSec/](https://pypi.org/project/NetSec/)\n\n## Runbook\n[](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 & copyright\n\n© Vignesh Rao, NetSec\n\nLicensed under the [MIT License](https://github.com/thevickypedia/NetSec/blob/main/LICENSE)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2020 Vignesh Rao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Python module to analyze devices connected to the router and alert accordingly.",
"version": "0.9.1",
"project_urls": {
"Bug Tracker": "https://github.com/thevickypedia/NetSec/issues",
"Docs": "https://thevickypedia.github.io/NetSec/",
"Homepage": "https://github.com/thevickypedia/NetSec",
"Release Notes": "https://github.com/thevickypedia/NetSec/blob/main/release_notes.rst",
"Source": "https://github.com/thevickypedia/NetSec"
},
"split_keywords": [
"netsec",
"network-security",
"lan",
"wlan"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d8a37ef2b032b5b9e0e33d46875f7697179a45cf7cd508844b556a560cbbafb3",
"md5": "5d22d87bc15d2a81be1ec8d741891418",
"sha256": "f563659229ad146fa142646b358b2622469fd3a13c397607b605b69861e93c4f"
},
"downloads": -1,
"filename": "NetSec-0.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d22d87bc15d2a81be1ec8d741891418",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12835,
"upload_time": "2023-08-16T03:54:45",
"upload_time_iso_8601": "2023-08-16T03:54:45.293730Z",
"url": "https://files.pythonhosted.org/packages/d8/a3/7ef2b032b5b9e0e33d46875f7697179a45cf7cd508844b556a560cbbafb3/NetSec-0.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-16 03:54:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "NetSec",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "netsec"
}
