theport


Nametheport JSON
Version 2.1.1 PyPI version JSON
download
home_pagehttps://github.com/ByteBreach/theport
SummaryA library for scanning ports and identifying services
upload_time2024-10-18 06:52:56
maintainerNone
docs_urlNone
authorMrFidal
requires_python>=3.6
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ThePort 2.1.1

ThePort is a Python library for scanning ports and identifying running services on a specified IP address. It allows users to find open ports and check their statuses.

- By using this tool you can scan ports very deep and list ports
  
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
  - [Basic Port Scanning](#basic-port-scanning)
  - [Scanning with User-Defined Ports](#scanning-with-user-defined-ports)
  - [Scanning All Ports](#scanning-all-ports)
  - [Asynchronous Scanning](#asynchronous-scanning)
- [Available Ports](#available-ports)
- [License](#license)
- [Contributing](#contributing)
- [Acknowledgments](#acknowledgments)

## Installation

To install ThePort, you can use pip:

```bash
pip install theport
```

## Usage

### Basic Port Scanning

To scan ports on a specific IP address and print the status of each port:

```bash
from theport import scan_ports

# Example IP address to scan
ip_address = '199.36.158.100'

# Custom list of ports to scan
custom_ports = [22, 80, 443, 3306, 8080]

# Start scanning
open_ports, closed_ports = scan_ports(ip_address, custom_ports)

# Print results
for port, service in open_ports:
    print(f"Port {port} is open: {service}")

for port in closed_ports:
    print(f"Port {port} is closed")
```

### Scanning with User-Defined Ports

You can specify your own list of ports to scan as follows:

```bash
from theport import scan_ports

# Example IP address to scan
ip_address = '199.36.158.100'

# Custom list of ports to scan
custom_ports = [21, 25, 80, 443]

# Start scanning
open_ports, closed_ports = scan_ports(ip_address, custom_ports)

# Print results
for port, service in open_ports:
    print(f"Port {port} is open: {service}")

for port in closed_ports:
    print(f"Port {port} is closed")
```

### Scanning All Ports

To scan all ports in the full range (1-65535):

```bash
from theport import scan_ports

# Example IP address to scan
ip_address = '199.36.158.100'

# Start scanning all ports
open_ports, closed_ports = scan_ports(ip_address)

# Print results
for port, service in open_ports:
    print(f"Port {port} is open: {service}")

for port in closed_ports:
    print(f"Port {port} is closed")
```

## Available Ports

ThePort supports a variety of commonly used ports, including but not limited to:

- **HTTP**: 80
- **HTTPS**: 443
- **FTP**: 21
- **SMTP**: 25, 587
- **MySQL**: 3306
- **SSH**: 22
- **Telnet**: 23
- **RDP**: 3389
- **PostgreSQL**: 5432
- **Redis**: 6379
- **MongoDB**: 27017

Feel free to extend the list as per your needs.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contributing

If you would like to contribute to ThePort, please open an issue or submit a pull request. Any help is greatly appreciated!

## Acknowledgments

Thank you for using ThePort! We appreciate your interest and support. If you find any issues or have suggestions, please let us know.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ByteBreach/theport",
    "name": "theport",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "MrFidal",
    "author_email": "mrfidal@proton.me",
    "download_url": "https://files.pythonhosted.org/packages/af/9a/4d874464133b33ff6836d417e1e6de91e330183b79d5e0fc5fc021a00c86/theport-2.1.1.tar.gz",
    "platform": null,
    "description": "# ThePort 2.1.1\r\n\r\nThePort is a Python library for scanning ports and identifying running services on a specified IP address. It allows users to find open ports and check their statuses.\r\n\r\n- By using this tool you can scan ports very deep and list ports\r\n  \r\n## Table of Contents\r\n- [Installation](#installation)\r\n- [Usage](#usage)\r\n  - [Basic Port Scanning](#basic-port-scanning)\r\n  - [Scanning with User-Defined Ports](#scanning-with-user-defined-ports)\r\n  - [Scanning All Ports](#scanning-all-ports)\r\n  - [Asynchronous Scanning](#asynchronous-scanning)\r\n- [Available Ports](#available-ports)\r\n- [License](#license)\r\n- [Contributing](#contributing)\r\n- [Acknowledgments](#acknowledgments)\r\n\r\n## Installation\r\n\r\nTo install ThePort, you can use pip:\r\n\r\n```bash\r\npip install theport\r\n```\r\n\r\n## Usage\r\n\r\n### Basic Port Scanning\r\n\r\nTo scan ports on a specific IP address and print the status of each port:\r\n\r\n```bash\r\nfrom theport import scan_ports\r\n\r\n# Example IP address to scan\r\nip_address = '199.36.158.100'\r\n\r\n# Custom list of ports to scan\r\ncustom_ports = [22, 80, 443, 3306, 8080]\r\n\r\n# Start scanning\r\nopen_ports, closed_ports = scan_ports(ip_address, custom_ports)\r\n\r\n# Print results\r\nfor port, service in open_ports:\r\n    print(f\"Port {port} is open: {service}\")\r\n\r\nfor port in closed_ports:\r\n    print(f\"Port {port} is closed\")\r\n```\r\n\r\n### Scanning with User-Defined Ports\r\n\r\nYou can specify your own list of ports to scan as follows:\r\n\r\n```bash\r\nfrom theport import scan_ports\r\n\r\n# Example IP address to scan\r\nip_address = '199.36.158.100'\r\n\r\n# Custom list of ports to scan\r\ncustom_ports = [21, 25, 80, 443]\r\n\r\n# Start scanning\r\nopen_ports, closed_ports = scan_ports(ip_address, custom_ports)\r\n\r\n# Print results\r\nfor port, service in open_ports:\r\n    print(f\"Port {port} is open: {service}\")\r\n\r\nfor port in closed_ports:\r\n    print(f\"Port {port} is closed\")\r\n```\r\n\r\n### Scanning All Ports\r\n\r\nTo scan all ports in the full range (1-65535):\r\n\r\n```bash\r\nfrom theport import scan_ports\r\n\r\n# Example IP address to scan\r\nip_address = '199.36.158.100'\r\n\r\n# Start scanning all ports\r\nopen_ports, closed_ports = scan_ports(ip_address)\r\n\r\n# Print results\r\nfor port, service in open_ports:\r\n    print(f\"Port {port} is open: {service}\")\r\n\r\nfor port in closed_ports:\r\n    print(f\"Port {port} is closed\")\r\n```\r\n\r\n## Available Ports\r\n\r\nThePort supports a variety of commonly used ports, including but not limited to:\r\n\r\n- **HTTP**: 80\r\n- **HTTPS**: 443\r\n- **FTP**: 21\r\n- **SMTP**: 25, 587\r\n- **MySQL**: 3306\r\n- **SSH**: 22\r\n- **Telnet**: 23\r\n- **RDP**: 3389\r\n- **PostgreSQL**: 5432\r\n- **Redis**: 6379\r\n- **MongoDB**: 27017\r\n\r\nFeel free to extend the list as per your needs.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## Contributing\r\n\r\nIf you would like to contribute to ThePort, please open an issue or submit a pull request. Any help is greatly appreciated!\r\n\r\n## Acknowledgments\r\n\r\nThank you for using ThePort! We appreciate your interest and support. If you find any issues or have suggestions, please let us know.\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A library for scanning ports and identifying services",
    "version": "2.1.1",
    "project_urls": {
        "Homepage": "https://github.com/ByteBreach/theport"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7c7370f114ff8dc619973478759a2dbab0c4995d784a51c283a3120181759883",
                "md5": "93fce80b8e129fa1561c2f2413d89dbd",
                "sha256": "9a9a753cacecefec734e860f4c787a3da75a4a6f93305bd86fc210c55fda2af1"
            },
            "downloads": -1,
            "filename": "theport-2.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "93fce80b8e129fa1561c2f2413d89dbd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 4492,
            "upload_time": "2024-10-18T06:52:54",
            "upload_time_iso_8601": "2024-10-18T06:52:54.999130Z",
            "url": "https://files.pythonhosted.org/packages/7c/73/70f114ff8dc619973478759a2dbab0c4995d784a51c283a3120181759883/theport-2.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "af9a4d874464133b33ff6836d417e1e6de91e330183b79d5e0fc5fc021a00c86",
                "md5": "e9c87900bf0ff049d1be63954dd628ce",
                "sha256": "1cf23e22a855b1a0265830262e2fbebdde670b6a840ba4b8006cea402193627c"
            },
            "downloads": -1,
            "filename": "theport-2.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "e9c87900bf0ff049d1be63954dd628ce",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 4286,
            "upload_time": "2024-10-18T06:52:56",
            "upload_time_iso_8601": "2024-10-18T06:52:56.985051Z",
            "url": "https://files.pythonhosted.org/packages/af/9a/4d874464133b33ff6836d417e1e6de91e330183b79d5e0fc5fc021a00c86/theport-2.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-18 06:52:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ByteBreach",
    "github_project": "theport",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "theport"
}
        
Elapsed time: 1.15286s