{"id":20629739,"url":"https://github.com/pb2204/py-portip","last_synced_at":"2025-10-16T23:09:31.881Z","repository":{"id":242624689,"uuid":"810086432","full_name":"PB2204/py-portip","owner":"PB2204","description":"PortIP is a Python package that allows you to ping websites and scan for open ports. It is also available for Linux terminals.","archived":false,"fork":false,"pushed_at":"2024-06-04T04:55:15.000Z","size":49,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-19T05:36:10.790Z","etag":null,"topics":["ethical-hacking-tools","linux-tools","pabitra-banerjee","python-package"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/portip/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PB2204.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-06-04T02:48:27.000Z","updated_at":"2024-07-25T02:54:04.000Z","dependencies_parsed_at":"2024-06-15T05:34:58.693Z","dependency_job_id":null,"html_url":"https://github.com/PB2204/py-portip","commit_stats":null,"previous_names":["pb2204/py-portip"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/PB2204/py-portip","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PB2204%2Fpy-portip","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PB2204%2Fpy-portip/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PB2204%2Fpy-portip/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PB2204%2Fpy-portip/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PB2204","download_url":"https://codeload.github.com/PB2204/py-portip/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PB2204%2Fpy-portip/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266691580,"owners_count":23969182,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ethical-hacking-tools","linux-tools","pabitra-banerjee","python-package"],"created_at":"2024-11-16T14:05:50.912Z","updated_at":"2025-10-16T23:09:26.831Z","avatar_url":"https://github.com/PB2204.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PortIP\n\n```\n _____           _   _____ _____  \n |  __ \\         | | |_   _|  __ \\ \n | |__) |__  _ __| |_  | | | |__) |\n |  ___/ _ \\| '__| __| | | |  ___/ \n | |  | (_) | |  | |_ _| |_| |     \n |_|   \\___/|_|   \\__|_____|_|     \n```\n\nPortIP is a Python package that allows you to ping websites and scan for open ports. It is also available for Linux terminals.\n\n## Installation\n\n### Using pip\n\nYou can install this library using pip:\n\n```bash\npip install portip\n```\n\n### Using apt-get (Linux)\n\nTo install PortIP on a Linux machine, use the following command:\n\n```bash\nsudo apt-get install portip\n```\n\n## Motive Of The Project\n\nNetwork administrators and security enthusiasts often need a tool to quickly check the status of network services and open ports on a server. This can help in ensuring that only necessary services are exposed and identify potential vulnerabilities. As a network enthusiast myself, I developed this tool to make the process straightforward and efficient.\n\nThis package is designed to be easy to use, even for those who are not proficient in Python programming. By following a few simple steps, you can scan websites for open ports and check their connectivity.\n\n## Structure Of The Project\n\n```\nportip/\n│\n├── portip/\n│   ├── __init__.py\n│   └── portip.py\n│\n├── CONTRIBUTING.md\n├── LICENSE\n├── README.md\n└── setup.py\n```\n\n## Usage (Windows Terminal / MAC Terminal)\n\nAfter installing the package, you can use the following commands in your terminal or command prompt:\n\n#### Ping a Website:\n\nTo ping a website and check its connectivity, use the following command:\n\n```bash\npython3 -m portip.portip 1 --url google.com\n```\n\nThis command will ping `google.com` with the default number of requests (4 by default).\n\n#### Scan for Open Ports:\n\nTo scan a website for open ports, use the following command:\n\n```bash\npython3 -m portip.portip 2 --url google.com\n```\n\nThis command will scan `google.com` for open ports using the default settings (scanning ports 1 to 1000 with 100 threads).\n\n#### Advanced Scanning Features:\n\nYou can enable advanced scanning features to improve port scanning accuracy. Use the `--advanced` flag with the scan command:\n\n```bash\npython3 -m portip.portip 2 --url google.com --advanced\n```\n\nThis command will enable advanced scanning features while scanning `google.com` for open ports.\n\n#### Specify Port Range:\n\nIf you want to specify a custom port range (e.g., ports 1-1000), use the `--port-range` option:\n\n```bash\npython3 -m portip.portip 2 --url google.com --port-range 1-1000\n```\n\nThis command will scan `google.com` for open ports within the specified port range.\n\n#### Adjust Number of Threads:\n\nTo change the number of threads used for port scanning, use the `--threads` option:\n\n```bash\npython3 -m portip.portip 2 --url google.com --threads 50\n```\n\nThis command will scan `google.com` for open ports using 50 threads instead of the default 100.\n\nReplace `google.com` with the URL of the website you want to ping or scan. Adjust the command-line options as needed to customize the behavior of the PortIP tool.\n\nFeel free to reach out if you have any questions or encounter any issues!\n\n## Usage (Linux Terminal)\n\nAfter installing the package, you can use the following commands in your terminal or command prompt:\n\n### Additional Setup on Linux\n\nBefore using the `portip` command, you need to ensure that the `portip.py` script is properly configured for use on a Linux machine.\n\n1. **Install `dos2unix`**:\n   If you haven't already installed `dos2unix`, you can do so using the following command:\n   ```bash\n   sudo apt-get install dos2unix\n   ```\n\n2. **Convert Line Endings**:\n   Navigate to the directory containing `portip.py` and run the following command to convert the line endings of the script file to Unix-style:\n   ```bash\n   dos2unix portip.py\n   ```\n\n   This command ensures that the script can be executed properly on a Linux machine.\n\n### Using the `portip` Command\n\n#### Ping a Website:\n\nTo ping a website and check its connectivity, use the following command:\n```bash\nportip 1 --url google.com\n```\nThis command will ping `google.com` with the default number of requests (4 by default).\n\n#### Scan for Open Ports:\n\nTo scan a website for open ports, use the following command:\n```bash\nportip 2 --url google.com\n```\nThis command will scan `google.com` for open ports using the default settings (scanning ports 1 to 1000 with 100 threads).\n\n#### Advanced Scanning Features:\n\nTo enable advanced scanning features while scanning for open ports, use the `--advanced` flag:\n```bash\nportip 2 --url google.com --advanced\n```\nThis command will enable advanced scanning features while scanning `google.com` for open ports.\n\n#### Specify Port Range:\n\nTo specify a custom port range (e.g., ports 1-1000) for scanning, use the `--port-range` option:\n```bash\nportip 2 --url google.com --port-range 1-1000\n```\nThis command will scan `google.com` for open ports within the specified port range.\n\n#### Adjust Number of Threads:\n\nTo change the number of threads used for port scanning, use the `--threads` option:\n```bash\nportip 2 --url google.com --threads 50\n```\nThis command will scan `google.com` for open ports using 50 threads instead of the default 100.\n\nReplace `google.com` with the URL of the website you want to ping or scan. Adjust the command-line options as needed to customize the behavior of the PortIP tool.\n\nFeel free to reach out if you have any questions or encounter any issues!\n\n## Contribution\n\nIf you want to contribute to this project, please follow the instructions in the [CONTRIBUTING.md](https://github.com/PB2204/py-portip/blob/main/CONTRIBUTING.md) file.\n\nHappy Hacking! 🚀","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpb2204%2Fpy-portip","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpb2204%2Fpy-portip","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpb2204%2Fpy-portip/lists"}