https://github.com/filiprokita/iplookup
A Python-based tool that performs IP address lookups using multiple services. Includes a command-line script and a Flask web application for easy querying and result display.
https://github.com/filiprokita/iplookup
api cli command-line-interface flask flask-app geolocation geolocation-services ip-geolocation ip-lookup json open-source python python-script requests web-application web-development
Last synced: 7 months ago
JSON representation
A Python-based tool that performs IP address lookups using multiple services. Includes a command-line script and a Flask web application for easy querying and result display.
- Host: GitHub
- URL: https://github.com/filiprokita/iplookup
- Owner: FilipRokita
- License: mit
- Created: 2024-08-10T22:10:21.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-04T23:50:01.000Z (8 months ago)
- Last Synced: 2025-03-05T00:28:11.788Z (8 months ago)
- Topics: api, cli, command-line-interface, flask, flask-app, geolocation, geolocation-services, ip-geolocation, ip-lookup, json, open-source, python, python-script, requests, web-application, web-development
- Language: HTML
- Homepage:
- Size: 95.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IP Lookup
This project consists of a Python script and a web application to perform IP address lookups using various IP geolocation services. The IP lookup can be executed via command line or through a web interface.
## Screenshot
This screenshot shows how the IP Lookup looks when running.
## Components
1. **`iplookup.py`**: A Python script that queries multiple IP geolocation services and returns the results.
2. **`index.html`**: A simple HTML page with a form to input an IP address and display the lookup results.
3. **`app.py`**: A Flask web application that serves the HTML page and handles IP lookup requests by invoking the `iplookup.py` script.
## Requirements
You can install the required Python libraries using pip:
```bash
pip3 install -r requirements.txt
```
## Usage
### Command Line
1. **Basic Lookup**:
To lookup an IP address, run:
```bash
python3 iplookup.py
```
This will output the results from all the geolocation services in JSON format.
2. **Save to File**:
To save the results to a file named `ip_lookup_result.json`, use:
```bash
python3 iplookup.py -s
```
### Web Interface
1. Start the Flask application:
```bash
python3 app.py
```
2. Open your web browser and navigate to `http://localhost:5000`.
3. Enter an IP address in the input field and click the "Lookup" button. The results will be displayed below the button.
## File Details
### `iplookup.py`
This script performs the IP lookup using various geolocation APIs. It defines a list of APIs and fetches information from each of them. The results are then printed or saved to a file based on the command-line arguments.
### `index.html`
This is a static HTML file providing a user interface to input an IP address and view the lookup results. The page is styled for simplicity and ease of use.
### `app.py`
This Flask application serves the HTML file and handles API requests. It calls the `iplookup.py` script to perform the IP lookup and returns the results as JSON.
## Troubleshooting
- **Error: IP address is required**: Ensure that you provide an IP address as a query parameter when using the web interface.
- **Error running script**: Make sure `iplookup.py` is in the same directory as `app.py` and that it is executable.
- **JSON decoding errors**: Verify that `iplookup.py` is generating valid JSON output.
## Contributing
Feel free to open issues or submit pull requests to improve the functionality or add more features. Contributions are welcome!
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
---
For any further questions or assistance, please feel free to contact the project maintainers. Happy IP lookup!