# PortIP
PortIP is a Python package that allows you to ping websites and scan for open ports. It is also available for Linux terminals.
## Installation
### Using pip
You can install this library using pip:
```bash
pip install portip
```
### Using apt-get (Linux)
To install PortIP on a Linux machine, use the following command:
```bash
sudo apt-get install portip
```
## Motive Of The Project
Network 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.
This 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.
## Structure Of The Project
```
portip/
│
├── portip/
│ ├── __init__.py
│ └── portip.py
│
├── CONTRIBUTING.md
├── LICENSE
├── README.md
└── setup.py
```
## Usage (Windows Terminal / MAC Terminal)
After installing the package, you can use the following commands in your terminal or command prompt:
#### Ping a Website:
To ping a website and check its connectivity, use the following command:
```bash
python3 -m portip.portip 1 --url google.com
```
This command will ping `google.com` with the default number of requests (4 by default).
#### Scan for Open Ports:
To scan a website for open ports, use the following command:
```bash
python3 -m portip.portip 2 --url google.com
```
This command will scan `google.com` for open ports using the default settings (scanning ports 1 to 1000 with 100 threads).
#### Advanced Scanning Features:
You can enable advanced scanning features to improve port scanning accuracy. Use the `--advanced` flag with the scan command:
```bash
python3 -m portip.portip 2 --url google.com --advanced
```
This command will enable advanced scanning features while scanning `google.com` for open ports.
#### Specify Port Range:
If you want to specify a custom port range (e.g., ports 1-1000), use the `--port-range` option:
```bash
python3 -m portip.portip 2 --url google.com --port-range 1-1000
```
This command will scan `google.com` for open ports within the specified port range.
#### Adjust Number of Threads:
To change the number of threads used for port scanning, use the `--threads` option:
```bash
python3 -m portip.portip 2 --url google.com --threads 50
```
This command will scan `google.com` for open ports using 50 threads instead of the default 100.
Replace `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.
Feel free to reach out if you have any questions or encounter any issues!
## Usage (Linux Terminal)
After installing the package, you can use the following commands in your terminal or command prompt:
### Additional Setup on Linux
Before using the `portip` command, you need to ensure that the `portip.py` script is properly configured for use on a Linux machine.
1. **Install `dos2unix`**:
If you haven't already installed `dos2unix`, you can do so using the following command:
```bash
sudo apt-get install dos2unix
```
2. **Convert Line Endings**:
Navigate to the directory containing `portip.py` and run the following command to convert the line endings of the script file to Unix-style:
```bash
dos2unix portip.py
```
This command ensures that the script can be executed properly on a Linux machine.
### Using the `portip` Command
#### Ping a Website:
To ping a website and check its connectivity, use the following command:
```bash
portip 1 --url google.com
```
This command will ping `google.com` with the default number of requests (4 by default).
#### Scan for Open Ports:
To scan a website for open ports, use the following command:
```bash
portip 2 --url google.com
```
This command will scan `google.com` for open ports using the default settings (scanning ports 1 to 1000 with 100 threads).
#### Advanced Scanning Features:
To enable advanced scanning features while scanning for open ports, use the `--advanced` flag:
```bash
portip 2 --url google.com --advanced
```
This command will enable advanced scanning features while scanning `google.com` for open ports.
#### Specify Port Range:
To specify a custom port range (e.g., ports 1-1000) for scanning, use the `--port-range` option:
```bash
portip 2 --url google.com --port-range 1-1000
```
This command will scan `google.com` for open ports within the specified port range.
#### Adjust Number of Threads:
To change the number of threads used for port scanning, use the `--threads` option:
```bash
portip 2 --url google.com --threads 50
```
This command will scan `google.com` for open ports using 50 threads instead of the default 100.
Replace `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.
Feel free to reach out if you have any questions or encounter any issues!
## Contribution
If 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.
Happy Hacking! 🚀
Raw data
{
"_id": null,
"home_page": null,
"name": "portip",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "python, port scanner, networking, IP, port",
"author": "Pabitra Banerjee",
"author_email": "<rockstarpabitra2204@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8c/00/f032788c854a4a5d75952a462a2dd04de3163ec495c809561b9b2a7b5a53/portip-1.1.0.tar.gz",
"platform": null,
"description": "\r\n# PortIP\r\n\r\n\r\n\r\nPortIP is a Python package that allows you to ping websites and scan for open ports. It is also available for Linux terminals.\r\n\r\n\r\n\r\n## Installation\r\n\r\n\r\n\r\n### Using pip\r\n\r\n\r\n\r\nYou can install this library using pip:\r\n\r\n\r\n\r\n```bash\r\n\r\npip install portip\r\n\r\n```\r\n\r\n\r\n\r\n### Using apt-get (Linux)\r\n\r\n\r\n\r\nTo install PortIP on a Linux machine, use the following command:\r\n\r\n\r\n\r\n```bash\r\n\r\nsudo apt-get install portip\r\n\r\n```\r\n\r\n\r\n\r\n## Motive Of The Project\r\n\r\n\r\n\r\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.\r\n\r\n\r\n\r\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.\r\n\r\n\r\n\r\n## Structure Of The Project\r\n\r\n\r\n\r\n```\r\n\r\nportip/\r\n\r\n\u2502\r\n\r\n\u251c\u2500\u2500 portip/\r\n\r\n\u2502 \u251c\u2500\u2500 __init__.py\r\n\r\n\u2502 \u2514\u2500\u2500 portip.py\r\n\r\n\u2502\r\n\r\n\u251c\u2500\u2500 CONTRIBUTING.md\r\n\r\n\u251c\u2500\u2500 LICENSE\r\n\r\n\u251c\u2500\u2500 README.md\r\n\r\n\u2514\u2500\u2500 setup.py\r\n\r\n```\r\n\r\n\r\n\r\n## Usage (Windows Terminal / MAC Terminal)\r\n\r\n\r\n\r\nAfter installing the package, you can use the following commands in your terminal or command prompt:\r\n\r\n\r\n\r\n#### Ping a Website:\r\n\r\n\r\n\r\nTo ping a website and check its connectivity, use the following command:\r\n\r\n\r\n\r\n```bash\r\n\r\npython3 -m portip.portip 1 --url google.com\r\n\r\n```\r\n\r\n\r\n\r\nThis command will ping `google.com` with the default number of requests (4 by default).\r\n\r\n\r\n\r\n#### Scan for Open Ports:\r\n\r\n\r\n\r\nTo scan a website for open ports, use the following command:\r\n\r\n\r\n\r\n```bash\r\n\r\npython3 -m portip.portip 2 --url google.com\r\n\r\n```\r\n\r\n\r\n\r\nThis command will scan `google.com` for open ports using the default settings (scanning ports 1 to 1000 with 100 threads).\r\n\r\n\r\n\r\n#### Advanced Scanning Features:\r\n\r\n\r\n\r\nYou can enable advanced scanning features to improve port scanning accuracy. Use the `--advanced` flag with the scan command:\r\n\r\n\r\n\r\n```bash\r\n\r\npython3 -m portip.portip 2 --url google.com --advanced\r\n\r\n```\r\n\r\n\r\n\r\nThis command will enable advanced scanning features while scanning `google.com` for open ports.\r\n\r\n\r\n\r\n#### Specify Port Range:\r\n\r\n\r\n\r\nIf you want to specify a custom port range (e.g., ports 1-1000), use the `--port-range` option:\r\n\r\n\r\n\r\n```bash\r\n\r\npython3 -m portip.portip 2 --url google.com --port-range 1-1000\r\n\r\n```\r\n\r\n\r\n\r\nThis command will scan `google.com` for open ports within the specified port range.\r\n\r\n\r\n\r\n#### Adjust Number of Threads:\r\n\r\n\r\n\r\nTo change the number of threads used for port scanning, use the `--threads` option:\r\n\r\n\r\n\r\n```bash\r\n\r\npython3 -m portip.portip 2 --url google.com --threads 50\r\n\r\n```\r\n\r\n\r\n\r\nThis command will scan `google.com` for open ports using 50 threads instead of the default 100.\r\n\r\n\r\n\r\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.\r\n\r\n\r\n\r\nFeel free to reach out if you have any questions or encounter any issues!\r\n\r\n\r\n\r\n## Usage (Linux Terminal)\r\n\r\n\r\n\r\nAfter installing the package, you can use the following commands in your terminal or command prompt:\r\n\r\n\r\n\r\n### Additional Setup on Linux\r\n\r\n\r\n\r\nBefore using the `portip` command, you need to ensure that the `portip.py` script is properly configured for use on a Linux machine.\r\n\r\n\r\n\r\n1. **Install `dos2unix`**:\r\n\r\n If you haven't already installed `dos2unix`, you can do so using the following command:\r\n\r\n ```bash\r\n\r\n sudo apt-get install dos2unix\r\n\r\n ```\r\n\r\n\r\n\r\n2. **Convert Line Endings**:\r\n\r\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:\r\n\r\n ```bash\r\n\r\n dos2unix portip.py\r\n\r\n ```\r\n\r\n\r\n\r\n This command ensures that the script can be executed properly on a Linux machine.\r\n\r\n\r\n\r\n### Using the `portip` Command\r\n\r\n\r\n\r\n#### Ping a Website:\r\n\r\n\r\n\r\nTo ping a website and check its connectivity, use the following command:\r\n\r\n```bash\r\n\r\nportip 1 --url google.com\r\n\r\n```\r\n\r\nThis command will ping `google.com` with the default number of requests (4 by default).\r\n\r\n\r\n\r\n#### Scan for Open Ports:\r\n\r\n\r\n\r\nTo scan a website for open ports, use the following command:\r\n\r\n```bash\r\n\r\nportip 2 --url google.com\r\n\r\n```\r\n\r\nThis command will scan `google.com` for open ports using the default settings (scanning ports 1 to 1000 with 100 threads).\r\n\r\n\r\n\r\n#### Advanced Scanning Features:\r\n\r\n\r\n\r\nTo enable advanced scanning features while scanning for open ports, use the `--advanced` flag:\r\n\r\n```bash\r\n\r\nportip 2 --url google.com --advanced\r\n\r\n```\r\n\r\nThis command will enable advanced scanning features while scanning `google.com` for open ports.\r\n\r\n\r\n\r\n#### Specify Port Range:\r\n\r\n\r\n\r\nTo specify a custom port range (e.g., ports 1-1000) for scanning, use the `--port-range` option:\r\n\r\n```bash\r\n\r\nportip 2 --url google.com --port-range 1-1000\r\n\r\n```\r\n\r\nThis command will scan `google.com` for open ports within the specified port range.\r\n\r\n\r\n\r\n#### Adjust Number of Threads:\r\n\r\n\r\n\r\nTo change the number of threads used for port scanning, use the `--threads` option:\r\n\r\n```bash\r\n\r\nportip 2 --url google.com --threads 50\r\n\r\n```\r\n\r\nThis command will scan `google.com` for open ports using 50 threads instead of the default 100.\r\n\r\n\r\n\r\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.\r\n\r\n\r\n\r\nFeel free to reach out if you have any questions or encounter any issues!\r\n\r\n\r\n\r\n## Contribution\r\n\r\n\r\n\r\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.\r\n\r\n\r\n\r\nHappy Hacking! \ud83d\ude80\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple IP and port scanner tool.",
"version": "1.1.0",
"project_urls": null,
"split_keywords": [
"python",
" port scanner",
" networking",
" ip",
" port"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "823f4f184ddd614332b5413f188555c65acb9ed86e95fa09ee3b7e255ce0cf54",
"md5": "b06e04a49d6f41a6574925e3b319d0cf",
"sha256": "07b4d9c12da69d808d6c41d9d6e174d07b38b0a9e7e7cec3f491105352835959"
},
"downloads": -1,
"filename": "portip-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b06e04a49d6f41a6574925e3b319d0cf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5997,
"upload_time": "2024-06-04T04:53:41",
"upload_time_iso_8601": "2024-06-04T04:53:41.610605Z",
"url": "https://files.pythonhosted.org/packages/82/3f/4f184ddd614332b5413f188555c65acb9ed86e95fa09ee3b7e255ce0cf54/portip-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c00f032788c854a4a5d75952a462a2dd04de3163ec495c809561b9b2a7b5a53",
"md5": "343bfc8fc3d677de223ab3dd0e0a81a2",
"sha256": "e272ba8927d56e87d6e757a15ef4abf26095232cb56e9403184209e595e07e1e"
},
"downloads": -1,
"filename": "portip-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "343bfc8fc3d677de223ab3dd0e0a81a2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6009,
"upload_time": "2024-06-04T04:53:44",
"upload_time_iso_8601": "2024-06-04T04:53:44.533430Z",
"url": "https://files.pythonhosted.org/packages/8c/00/f032788c854a4a5d75952a462a2dd04de3163ec495c809561b9b2a7b5a53/portip-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-04 04:53:44",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "portip"
}
JSON