Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dmachard/python-publicaddr

Getting your V4/V6 public IP from random providers in several ways (DNS, HTTPS or STUN)
https://github.com/dmachard/python-publicaddr

Last synced: about 5 hours ago
JSON representation

Getting your V4/V6 public IP from random providers in several ways (DNS, HTTPS or STUN)

Host: GitHub
URL: https://github.com/dmachard/python-publicaddr
Owner: dmachard
License: mit
Created: 2022-08-24T06:40:05.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-11-10T08:42:03.000Z (1 day ago)
Last Synced: 2024-11-10T09:28:23.454Z (1 day ago)
Language: Python
Homepage:
Size: 119 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        ![Testing](https://github.com/dmachard/python-publicaddr/workflows/Testing/badge.svg) ![Build](https://github.com/dmachard/python-publicaddr/workflows/Build/badge.svg) ![Publish](https://github.com/dmachard/python-publicaddr/workflows/Publish/badge.svg)

# What is this?

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Simple python module for getting your **public IP V4 and V6** from several providers in **random** mode with also several protocols (DNS, HTTPS and STUN).

Supported providers with IPv4 and IPv6:

- [x] Google (DNS & HTTP & STUN)

- [x] Cloudflare (DNS & HTTP)

- [x] OpenDNS (DNS)

- [x] Akamai (DNS & HTTP)

- [x] [Ipify](https://www.ipify.org/) (HTTP)

- [x] Icanhazip (HTTP)

- [x] [Matrix](https://www.matrix.org) (STUN)

- [x] [Framasoft](https://framasoft.org/) (STUN)

- [x] [Ifconfig.me](https://ifconfig.me/) (HTTP)

## Installation

![python 3.12.x](https://img.shields.io/badge/python%203.12.x-tested-blue) ![python 3.11.x](https://img.shields.io/badge/python%203.11.x-tested-blue) ![python 3.10.x](https://img.shields.io/badge/python%203.10.x-tested-blue)

This module can be installed from [pypi](https://pypi.org/project/publicaddr/) website

```bash

pip install publicaddr

```

## Lookup for IPv4 and v6

Lookup for your public IPs from random providers with DNS or HTTP protocols with 3 retries if no ips are returned.

This is the default behaviour of the `lookup` function.

```python

import publicaddr

publicaddr.lookup()

{'ip4': 'x.x.x.x', 'ip6': 'x:x:x:x:x:x:x:x', 'provider': 'opendns',

'proto': 'dns', 'duration': '0.037'}

```

## Lookup for public IP with specific protocol

Lookup for your public IPs from random DNS providers with specific protocol.

```python

import publicaddr

publicaddr.lookup(providers=publicaddr.DNS, retries=2)

{'ip4': 'x.x.x.x', 'ip6': 'x:x:x:x:x:x:x:x', 'provider': 'opendns',

'proto': 'dns', 'duration': '0.037'}

```

Default constants for transport protocol:

- `publicaddr.HTTPS`

- `publicaddr.DNS`

- `publicaddr.STUN`

## Get IPv4 or IPv6 only

Get your public IPv4 with default provider (Google with DNS protocol).

```python

import publicaddr

publicaddr.get(ip=publicaddr.IPv4)

{'ip': 'x.x.x.x', 'duration': '0.025'}

```

Default constants for IP version:

- `publicaddr.IPv4`

- `publicaddr.IPv6`

## Get IP with specific provider

Example to use the provider Cloudflare instead of the default one.

```python

import publicaddr

myip = publicaddr.get(provider=publicaddr.CLOUDFLARE, proto=publicaddr.DNS)

{'ip': 'x:x:x:x:x:x:x:x', 'duration': '0.020'}

```

Default constants for providers:

- `publicaddr.CLOUDFLARE`

- `publicaddr.GOOGLE`

- `publicaddr.OPENDNS`

- `publicaddr.AKAMAI`

- `publicaddr.IPIFY`

- `publicaddr.ICANHAZIP`

- `publicaddr.MATRIX`

- `publicaddr.FRAMASOFT`

- `publicaddr.MULLVAD` *(disabled by default in config because IPv6 is not supported)*

- `publicaddr.IFCONFIG_ME`

## Custom configuration

See the default [configuration file](../main/publicaddr/publicaddr.yml)

## For developpers

### Run from source

```bash

sudo apt install python3-venv

python3 -m venv venv

source venv/bin/activate

```

```bash

python3 -m pip install -r requirements.txt

python3 example.py

```

### Run test units

```bash

python3 -m unittest discover tests/

```