The tool to check the availability or syntax of domain, IP or URL.
Welcome to PyFunceble!
PyFunceble is a tool that aims to provide an accurate availability check through the usage of multiple sources which are for example - to only list a few:
the WHOIS record(s).
the DNS record(s).
the HTTP status code.
PyFunceble can be included in your existing project through:
its standard built-in CLI implementation.
its Python API.
the PyFunceble web-worker project that provides the core functionalities of PyFunceble behind a web API.
The PyFunceble CLI can test from a hosts file, a plain list of subjects, an AdBlock filter list or even an RPZ record.
As of today, PyFunceble is running actively - if not daily - within several servers, laptops, PCs, and Raspberry Pis. It is even used - thanks to our auto continue mechanism - with CI engines like GitHub Action, Travis CI, or GitLab CI.
Happy testing with PyFunceble!
- Configuration
- Location
- Autoconfiguration
- Indexes
share_logs
verify_ssl_certificate
max_http_retries
debug
cli_decoding
cli_testing
cli_testing[hosts_ip]
cli_testing[max_workers]
cli_testing[autocontinue]
cli_testing[inactive_db]
cli_testing[whois_db]
cli_testing[cidr_expand]
cli_testing[complements]
cli_testing[cooldown_time]
cli_testing[db_type]
cli_testing[file_filter]
cli_testing[mining]
cli_testing[local_network]
cli_testing[preload_file]
cli_testing[chancy_tester]
cli_testing[ci]
cli_testing[display_mode]
cli_testing[display_mode][dots]
cli_testing[display_mode][dots]
cli_testing[display_mode][execution_time]
cli_testing[display_mode][percentage]
cli_testing[display_mode][registrar]
cli_testing[display_mode][quiet]
cli_testing[display_mode][less]
cli_testing[display_mode][all]
cli_testing[display_mode][simple]
cli_testing[display_mode][status]
cli_testing[display_mode][colour]
cli_testing[display_mode][max_registrar]
cli_testing[testing_mode]
cli_testing[days_between]
cli_testing[sorting_mode]
cli_testing[file_generation]
lookup
dns
proxy
user_agent
http_codes
links
platform
- Usage
- PyFunceble Python API
- From a terminal
- Github Actions CI/CD
- GitLab Runner CI/CD
- Travis container CI/CD
- Deprecated arguments
-ad
-nw
|--no-whois
--shadow-file
|--shadow
--use-reputation-data
--dns-lookup-over-tcp
-db | --database
-dbc "something" | --days-between-db-clean
-json
-less
-nf
-nl
|--no-logs
-nu | --no-unified
--split
--store-whois
-m | --multiprocess
-p | --processes
--multiprocess-merging-mode
--autosave-minutes
--cmd
--cmd-before-end
- Responses
- API Responses
- API Responses (explained)
checker_type
idna_subject
params
status
registrar
status_after_extra_rules
status_before_extra_rules
status_source
status_source_after_extra_rules
status_source_before_extra_rules
subject
tested_at
dns_lookup
dns_lookup_record
domain_syntax
expiration_date
http_status_code
ip_syntax
ipv4_range_syntax
ipv4_syntax
ipv6_range_syntax
ipv6_syntax
second_level_domain_syntax
subdomain_syntax
url_syntax
netinfo
netloc
whois_lookup_record
whois_lookup
- CLI Responses
- Components
- AdBlock/Filter list decoding
- Autocontinue
- Certificate verification
- Cleaning
- Complements Generation
- Configuration
- Continuous Integration
- Custom DNS Protocol
- Custom DNS Server
- Custom User-Agent
- Databases
- Directory Structure
- DNS Lookup
- Proxy Settings - Matcher
- Environment variables
- Execution time
- Expiration Date
- List filtering
- HTTP Status Code
- IANA Root Zone Database
- Test in/for local hostnames, IPs, components
- Logs Sharing
- Mining
- Multiprocessing
- Outputted Files
- Percentage
- The Public Suffix List
- Sorting
- SPECIAL rules
- Status
- Status Source
- Whois Lookup
- Code Documentation
- PyFunceble package
- Subpackages
- PyFunceble.checker package
- PyFunceble.cli package
- PyFunceble.config package
- PyFunceble.converter package
- Submodules
- PyFunceble.converter.adblock_input_line2subject module
- PyFunceble.converter.base module
- PyFunceble.converter.cidr2subject module
- PyFunceble.converter.input_line2subject module
- PyFunceble.converter.internal_url module
- PyFunceble.converter.rpz_input_line2subject module
- PyFunceble.converter.rpz_policy2subject module
- PyFunceble.converter.subject2complements module
- PyFunceble.converter.url2netloc module
- PyFunceble.converter.wildcard2subject module
- Module contents
- PyFunceble.data package
- PyFunceble.database package
- PyFunceble.dataset package
- Subpackages
- Submodules
- PyFunceble.dataset.base module
- PyFunceble.dataset.csv_base module
- PyFunceble.dataset.db_base module
- PyFunceble.dataset.iana module
- PyFunceble.dataset.ipv4_reputation module
- PyFunceble.dataset.public_suffix module
- PyFunceble.dataset.sql_base module
- PyFunceble.dataset.user_agent module
- Module contents
- PyFunceble.downloader package
- PyFunceble.helpers package
- Submodules
- PyFunceble.helpers.command module
- PyFunceble.helpers.dict module
- PyFunceble.helpers.directory module
- PyFunceble.helpers.download module
- PyFunceble.helpers.environment_variable module
- PyFunceble.helpers.exceptions module
- PyFunceble.helpers.file module
- PyFunceble.helpers.hash module
- PyFunceble.helpers.list module
- PyFunceble.helpers.merge module
- PyFunceble.helpers.regex module
- Module contents
- PyFunceble.query package
- PyFunceble.utils package
- Submodules
- PyFunceble.exceptions module
- PyFunceble.facility module
- PyFunceble.factory module
- PyFunceble.logger module
Logger
Logger.OWN_FORMAT
Logger.ROOT_FORMAT
Logger.STD_MIN_LEVEL
Logger.activated
Logger.authorized
Logger.critical()
Logger.critical_logger
Logger.debug()
Logger.debug_logger
Logger.destroy_loggers()
Logger.env_var_helper
Logger.error()
Logger.error_logger
Logger.exception()
Logger.fatal()
Logger.fatal_logger
Logger.get_handler()
Logger.get_next_logger()
Logger.get_origin()
Logger.guess_all_settings()
Logger.guess_and_set_min_level()
Logger.info()
Logger.info_logger
Logger.init_loggers()
Logger.min_level
Logger.on_file
Logger.on_screen
Logger.output_directory
Logger.own_formatter
Logger.root_formatter
Logger.set_activated()
Logger.set_min_level()
Logger.set_output_directory()
Logger.single_logger_factory()
Logger.sqlalchemy_logger
Logger.warning()
Logger.warning_logger
- PyFunceble.sessions module
- PyFunceble.storage module
- PyFunceble.storage_facility module
- Module contents
- Subpackages
- PyFunceble package