Skip to content

Latest commit

 

History

History
103 lines (77 loc) · 1.95 KB

Readme.md

File metadata and controls

103 lines (77 loc) · 1.95 KB
Raw

Free IP Checker

Description

Two scrips to check the free or used ips. If need a api server also is avalible to run the script on a server and get data.

Requirements

If you just want to use the main script without API server you need only Python Python >= 3.9

Download

If you want to use the api server please install the requirements.txt via pip

Windows:

pip install -r requirements.txt

Linux

pip3 install -r requirements.txt

Settings

IP search range

seach_ip = "192.168.2." The IP range

first ip (last ip section)

seach_start = 0 First IP in the last section

last ip (last ip section)

seach_end = 255 Last IP in the last section

Process to use

process = 10 How many process should check the IPs

What to Search?

online = True If online = True you get all omline IPs

Save as File?

save = True Save the IP to a file

Print at end?

print_out = False Print the IP at the end?

Output

output = output/ Path to save the output. Be shure dont forget the / at the end!

Log

Log File

log_file = service.log File to save the log

Log Level

level = info Level to log

Log Path

path = . Path to save the log

API

Host

host = 127.0.0.1 The host for the API Server

Port

port = 8000 API Server Port

Usage

Just set your settings like you need in the config.ini If you just want to chek the free IPs run

Windows:

python main.py

Linux:

python3 main.py

If you want also to use the API Server:

Windows

python api_server.py

Linux

python3 api_server.py

The docs you can find on http://host:port/docs

If you want to test some Endpoints the Swagger UI is also avalible on http://host:port/testdocs

I recomend to use Postman to test the api

TODO:

  • HTTPS support
  • Save last Check via API request
  • Extend Endpoints
  • Extend Docs
  • Add ping latenz
  • Docs