==================
python-netdiscover
==================
.. image:: https://img.shields.io/pypi/v/python-netdiscover.svg
:target: https://pypi.python.org/pypi/python-netdiscover
.. image:: https://img.shields.io/pypi/pyversions/python-netdiscover.svg
:target: https://pypi.python.org/pypi/python-netdiscover
The python-netdiscover is a simple wrapper for the `netdiscover reconnaissance tool <https://sourceforge.net/projects/netdiscover/>`_.
This library offers a simple way to create scans from a python script and analyse the results.
* Documentation: https://python-netdiscover.readthedocs.io
* GitHub: https://github.com/MrSuicideParrot/python-netdiscover
* PyPI: https://pypi.org/project/python-netdiscover/
Installation
============
First, you will need to install the `netdiscover binary <https://sourceforge.net/projects/netdiscover/>`_ on your system, this may depend on your operating system. Many distributions have this tool available in `their main repository <https://pkgs.org/download/netdiscover>`_.
From the shell, uncompress python-netdiscover.tar.gz and then run make :
.. code-block:: bash
$ tar xvzf python-netdiscover.tar.gz
$ cd python-netdiscover
$ python setup.py install
or using Pip
.. code-block:: bash
$ pip install python-netdiscover
Usage
=====
From python/ipython:
--------------------
.. code-block:: python
>>> from netdiscover import *
>>> disc = Discover()
>>> disc.scan(ip_range="192.168.1.0/24")
[{'mac': b'73:8b:10:0e:bd:23', 'ip': b'192.168.1.1'}, {'mac': b'f4:3c:4a:73:47:07', 'ip': b'192.168.1.2'}]
Notes
=====
This tool needs to be run as root. It is necessary to be presented on the system the *netdiscover* tool. The library will look for the *netdiscovery* binary in the following paths:
* netdiscover
* /usr/bin/netdiscover
* /usr/sbin/netdiscover
* /usr/local/bin/netdiscover
* /sw/bin/netdiscover
* /opt/local/bin/netdiscover
If *netdiscovery* is not present in any of the paths above, you can specifie path with the argument *netdiscover_path* on Discover class.
.. code-block:: python
disc = Discover(netdiscover_path="path_of_netdiscover")
Raw data
{
"_id": null,
"home_page": "https://github.com/MrSuicideParrot/python-netdiscover",
"name": "python-netdiscover",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "network,netdiscover,arpscanner,sysadmin",
"author": "Andr\u00e9 Cirne",
"author_email": "ancirne@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/cf/6c/c771e552855b7d05ce91856ab7f07f189aba0ad1abb837ce9cb9d19f293d/python-netdiscover-0.3.0.tar.gz",
"platform": null,
"description": "==================\npython-netdiscover\n==================\n\n.. image:: https://img.shields.io/pypi/v/python-netdiscover.svg\n :target: https://pypi.python.org/pypi/python-netdiscover\n\n.. image:: https://img.shields.io/pypi/pyversions/python-netdiscover.svg\n :target: https://pypi.python.org/pypi/python-netdiscover\n\nThe python-netdiscover is a simple wrapper for the `netdiscover reconnaissance tool <https://sourceforge.net/projects/netdiscover/>`_.\n\nThis library offers a simple way to create scans from a python script and analyse the results.\n\n\n* Documentation: https://python-netdiscover.readthedocs.io\n* GitHub: https://github.com/MrSuicideParrot/python-netdiscover\n* PyPI: https://pypi.org/project/python-netdiscover/\n\nInstallation\n============\nFirst, you will need to install the `netdiscover binary <https://sourceforge.net/projects/netdiscover/>`_ on your system, this may depend on your operating system. Many distributions have this tool available in `their main repository <https://pkgs.org/download/netdiscover>`_. \n\nFrom the shell, uncompress python-netdiscover.tar.gz and then run make :\n\n.. code-block:: bash\n\n $ tar xvzf python-netdiscover.tar.gz\n $ cd python-netdiscover\n $ python setup.py install\n\nor using Pip\n\n.. code-block:: bash\n\n $ pip install python-netdiscover\n\n\nUsage\n=====\nFrom python/ipython:\n--------------------\n\n.. code-block:: python\n\n >>> from netdiscover import *\n >>> disc = Discover()\n >>> disc.scan(ip_range=\"192.168.1.0/24\")\n [{'mac': b'73:8b:10:0e:bd:23', 'ip': b'192.168.1.1'}, {'mac': b'f4:3c:4a:73:47:07', 'ip': b'192.168.1.2'}]\n\n\nNotes\n=====\nThis tool needs to be run as root. It is necessary to be presented on the system the *netdiscover* tool. The library will look for the *netdiscovery* binary in the following paths:\n\n* netdiscover\n* /usr/bin/netdiscover\n* /usr/sbin/netdiscover\n* /usr/local/bin/netdiscover\n* /sw/bin/netdiscover\n* /opt/local/bin/netdiscover\n\nIf *netdiscovery* is not present in any of the paths above, you can specifie path with the argument *netdiscover_path* on Discover class.\n\n.. code-block:: python\n\n disc = Discover(netdiscover_path=\"path_of_netdiscover\")\n",
"bugtrack_url": null,
"license": "GNU General Public License v3",
"summary": "python-netdiscover is a simple wrapper for the netdiscover reconnaissance tool",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/MrSuicideParrot/python-netdiscover"
},
"split_keywords": [
"network",
"netdiscover",
"arpscanner",
"sysadmin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "48986a496111f03bb97a7767027c616ce5bab5af70acca1ee841f8757a2270a7",
"md5": "cc1f5b7b769802cc4117f52a58acaab2",
"sha256": "47293c440a8693ca095a911020c8445de6463af8ff1adbf7e320d8bd2bd67137"
},
"downloads": -1,
"filename": "python_netdiscover-0.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc1f5b7b769802cc4117f52a58acaab2",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 17008,
"upload_time": "2023-06-27T08:11:24",
"upload_time_iso_8601": "2023-06-27T08:11:24.128839Z",
"url": "https://files.pythonhosted.org/packages/48/98/6a496111f03bb97a7767027c616ce5bab5af70acca1ee841f8757a2270a7/python_netdiscover-0.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cf6cc771e552855b7d05ce91856ab7f07f189aba0ad1abb837ce9cb9d19f293d",
"md5": "894d1a80c4edf331b48c2bb2b2d336cd",
"sha256": "45619a81448752d295119ac8ef80b4768f9319aca2e50a41639d331d5a88edce"
},
"downloads": -1,
"filename": "python-netdiscover-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "894d1a80c4edf331b48c2bb2b2d336cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23140,
"upload_time": "2023-06-27T08:11:25",
"upload_time_iso_8601": "2023-06-27T08:11:25.849207Z",
"url": "https://files.pythonhosted.org/packages/cf/6c/c771e552855b7d05ce91856ab7f07f189aba0ad1abb837ce9cb9d19f293d/python-netdiscover-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-27 08:11:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MrSuicideParrot",
"github_project": "python-netdiscover",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "python-netdiscover"
}
JSON
