Metadata-Version: 2.1
Name: hostfinder
Version: 1.0.1
Summary: Find hosts listening on specified port in local network
Author-email: Quinten Roets <qdr2104@columbia.edu>
License: MIT
Project-URL: Source Code, https://github.com/quintenroets/hostfinder
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: psutil <6,>=5.9.8
Provides-Extra: dev
Requires-Dist: hypothesis <7,>=6.100.0 ; extra == 'dev'
Requires-Dist: package-dev-tools <1,>=0.5.11 ; extra == 'dev'
Requires-Dist: package-dev-utils <2,>=0.1.6 ; extra == 'dev'
Requires-Dist: types-psutil <6,>=5.9.5.20240316 ; extra == 'dev'

# Host finder
[![PyPI version](https://badge.fury.io/py/hostfinder.svg)](https://badge.fury.io/py/hostfinder)
![Python version](https://img.shields.io/badge/python-3.10+-brightgreen)
![Operating system](https://img.shields.io/badge/os-linux%20%7c%20macOS%20%7c%20windows-brightgreen)
![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)

Find hosts listening on specified port in local network

## Usage
1) Command line

    ```shell
    hostfinder --port 8080
    ```

2) Python module

    ```python
    import hostfinder
    from hostfinder import Options

    options = Options(port=8080)

    # first host listening on a port
    host = hostfinder.find_host(options)

    # all hosts listening on a port
    hosts = hostfinder.find_hosts(options)
    ```

## Installation
```shell
pip install hostfinder
```
