Skip to main content

A new way to query the ports of a given hostname of IP address

Project description

Welcome to portcheckerio 👋

PyPI PyPI - Python Version GitHub license Pytest CodeQL

This repository is the counterpart script which ports portchecker.io

This package is a nice alternative way to using tools like nc to query the port connectivity. The main benefits is that it will work with hostnames, IPv4 and IPv6 addresses (if your client has IPv6 of course). You can also query multiple ports at the same time and receive a sweet JSON response.

Installation

Portchecker can be installed from PyPI using pip or your package manager of choice:

pip install portcheckerio

Usage

CLI

You can use Portchecker as a CLI tool using the portcheck command.

Example:

$ portcheck --host google.com --ports 443
{
    "2a00:1450:4009:815::200e": {
        "type": "ipv6",
        "results": [
            {
                "port": 443,
                "connectable": true
            }
        ]
    },
    "172.217.16.238": {
        "type": "ipv4",
        "results": [
            {
                "port": 443,
                "connectable": true
            }
        ]
    }
}

You can query multiple ports for a given host in the same command:

$ portcheck --host google.com --ports 443 22
{
    "172.217.16.238": {
        "type": "ipv4",
        "results": [
            {
                "port": 443,
                "connectable": true
            },
            {
                "port": 22,
                "connectable": false
            }
        ]
    },
    "2a00:1450:4009:815::200e": {
        "type": "ipv6",
        "results": [
            {
                "port": 443,
                "connectable": true
            },
            {
                "port": 22,
                "connectable": false
            }
        ]
    }
}

📝 To Do

  • Add more tests
  • Add the option to query RFC1918 addresses
  • Add the option to increase the timeout limit

🏠 Homepage

Demo

Author

👤 Dan Hand

🤝 Contributing

Contributions, issues and feature requests are welcome.
Feel free to check issues page if you want to contribute.

Show your support

Give a ⭐️ if this project helped you!

Any donations to help the running of the site is hugely appreciated!

📝 License

Copyright © 2019 Dan Hand.
This project is MIT licensed.



This README was generated with ❤️ by readme-md-generator

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

portcheckerio-0.1.3.tar.gz (6.1 kB view hashes)

Uploaded source

Built Distribution

portcheckerio-0.1.3-py3-none-any.whl (6.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page