The tool to check the availability or syntax of domain, IP or URL.
Project description
The tool to check the availability or syntax of domain, IP or URL
Welcome to PyFunceble!
PyFunceble is the little sister of Funceble which was archived on 13th March 2018. In March 2018, because Funceble was starting to become a huge unmanageable script, I - Nissar Chababy aka @funilrys - decided to make it a Python tool for the purpose of extending my Python knowledge. It was meant for my own use case.
Back then, my problem was that I didn’t want to download a huge hosts file knowing that most of the entries do not exist anymore. That’s how Py-Funceble started.
My objective - now - through this tool is to provide a tool and a Python API which helps the world test the availability of domains, IPs and URL through the gathering and interpretation of information from existing tools or protocols like WHOIS records, DNS lookup, or even HTTP status codes.
The base of this tool was my idea. But as with many Open Source (related) projects, communities or individuals, we evolve with the people we meet, exchange with or just discuss with privately. PyFunceble was and is still not an exception to that.
My main idea was to check the availability of domains in hosts files. But 3 years later, PyFunceble is now capable of a lot including:
The testing of domains, IPs, and URLs.
The checking of the syntax or reputation of a domain, IPs, and URLs.
The decoding of AdBlock filters, RPZ records, or plain files before a test from the CLI.
PyFunceble evolved and will probably continue to evolve with the time and the people using it.
In June 2020, The PyFunceble-dev PyPI package - which gets everything as soon as possible compared to the PyFunceble (stable) package - reached 1 million total downloads. I never noticed it until I was reached by someone informing me of it. But, I was shocked.
I never thought that something I built from A to Z in my free time will ever reach that point. I was thankful to that nice person for informing me of it. But at the same time concerned about PyFunceble and how it will evolve. That’s why I started the development of PyFunceble 4.0.0. My idea as I was refactoring it was to provide a better Python API and implementation of my core ideas along with a better incorporation and extension capability. Indeed, in the last few years, I was so much obsessed with the CLI that I really never wrote each component individually. They were all dependent - if not part of - the CLI. With 4.0.0, you can now import one of the components of PyFunceble and start straight away. No real need to play with the configuration unless you want something very specific. That’s how I see the future of PyFunceble.
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 dataset and component - with CI engines like GitHub Action, Travis CI, and GitLab CI.
PyFunceble is my tool. But it is indirectly also become yours. Therefore, I invite you to let me know how you use PyFunceble or simply open a discussion - or join an existing one - about anything you do with PyFunceble. But also anything that you - would - like - or dislike - in PyFunceble.
Happy testing with PyFunceble!
Documentation as the place to be!
Want to know more about details PyFunceble? I invite you to read the documentation at https://pyfunceble.readthedocs.io/en/dev/!
Want a local copy? I get you covered!
Simply run the following and enjoy the documentation!
$ pip install --user -r requirements.docs.txt # Install dependencies. $ cd docs/ $ make clean html $ palemoon _build/html/index.html # palemoon or whatever browser you use.
What can PyFunceble do?
Test the availability of a domain.
Test the availability of an IPv4.
Test the availability of an IPv6.
Test the availability of a URL.
Test the availability of a domain/DNS name in a private or local network.
Test the availability of an IPv4 in a private or local network.
Test the availability of an IPv6 in a private or local network.
Test the availability of a URL in a private or local network.
Test the syntax of a domain.
Test the syntax of an IPv4.
Test the syntax of an IPv6.
Test the syntax of a URL.
Test against the AlienVault’s reputation of an IPv4.
Test of domain or IP which are present into an Adblock formatted file.
Test from a given raw link.
Test using multiprocessing (from CLI only).
Save test result(s) in file(s) (hosts file, plain text and/or JSON format).
Save test result(s) in a MySQL or MariaDB database.
Show test result(s) on screen.
Show percentage of each status (
ACTIVE
,INACTIVE
,INVALID
)Sort outputs hierarchically.
“Mining” of domain or IP which are related to the tested element.
Auto-continuation of tests in case of system crash or script stop.
Filtering of a file content.
This feature will let us for example test all blogspot domain of the given file no matter the content of the file.
Set the user-agent to use for the tests.
Give some analytic depending of the HTTP status code (
ACTIVE
,POTENTIALLY_ACTIVE
,POTENTIALLY_INACTIVE
,SUSPICIOUS
).Retest overtime of
INACTIVE
andINVALID
domains.Print the execution time on screen and file.
Customisation of the different option via command-line arguments or configuration file.
Continuous tests under Travis CI or GitLab CI/CI
… with the help of an auto saving and database system.
Set the branch to push the result to. For the autosaving system.
Set the minimal time before we autosave in order to avoid CI/CD limitation.
Set a command to execute at the end of the test.
Set the commit message for the autosaving system.
… and a lot more!
Supporting the project
PyFunceble, Dead-Hosts, and all other analog projects are powered by free time and a lot of coffee!
This project helps you and/or you like it?
GitHub Sponsor
@funilrys is part of the GitHub Sponsor program!
GitHub will match all donation for the coming months!
Ko-Fi
Don’t want to use the GitHub Sponsor program ? Single donations are welcome too!
Contributors
Thanks to those awesome peoples for their awesome and crazy idea(s), contribution(s) and or issue report which made or make PyFunceble a better tool.
_______ _ _ _ _ |__ __| | | | | | | | | | | |__ __ _ _ __ | | _____ | |_ ___ _ _ ___ _ _ | | | | | '_ \ / _` | '_ \| |/ / __| | __/ _ \ | | | |/ _ \| | | | | | | | | | | | (_| | | | | <\__ \ | || (_) | | |_| | (_) | |_| | |_| |_| |_| |_|\__,_|_| |_|_|\_\___/ \__\___/ \__, |\___/ \__,_| (_) __/ | |___/
Daniel - @dnmTX
hawkeye116477 - @hawkeye116477
Imre Kristoffer Eilertsen - @DandelionSprout
jawz101 - @jawz101
kowith337 - @kowith337
Mitchell Krog - @mitchellkrogza
NeolithEra - @NeolithEra
Odyseus - @Odyseus
opav - @opav
Reza Rizqullah - @ybreza
sjhgvr - @sjhgvr
ScriptTiger - @ScriptTiger
speedmann - @speedmann
spirillen - @spirillen
The Unknown - @AnonymousPoster
WaLLy3K - @WaLLy3K
xxcriticxx - @xxcriticxx
ZeroDot1 - @ZeroDot1
Special Thanks
Thanks to those awesome organization(s), tool(s) and or people(s) for
Their awesome documentation
Their awesome repository
Their awesome tool/software/source code
Their breaking reports
Their contributions
Their current work/purpose
Their promotion of Py-Funceble
Their support
Their testings reports
which helped and/or still help me build, test and or make PyFunceble a better tool.
_______ _ _ _ _ |__ __| | | | | | | | | | | |__ __ _ _ __ | | _____ | |_ ___ _ _ ___ _ _ | | | | | '_ \ / _` | '_ \| |/ / __| | __/ _ \ | | | |/ _ \| | | | | | | | | | | | (_| | | | | <\__ \ | || (_) | | |_| | (_) | |_| | |_| |_| |_| |_|\__,_|_| |_|_|\_\___/ \__\___/ \__, |\___/ \__,_| (_) __/ | |___/
Adam Warner - @PromoFaux
Adblock Plus - @adblockplus
asciinema - @asciinema
Chris Griffith - @cdgriffith (Box)
Daniel - @dnmTX
Kenneth Reitz - @kennethreitz (requests)
Mitchell Krog - @mitchellkrogza
Mohammad Fares - @faressoft (Terminalizer)
Pi-Hole - @pi-hole
Public Suffix List - @publicsuffix
Reza Rizqullah - @ybreza
Saurabh Kumar - @theskumar (python-dotenv)
ScriptTiger - @ScriptTiger
SMed79 - @SMed79
spirillen - @spirillen
License
Copyright 2017, 2018, 2019, 2020, 2021 Nissar Chababy Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for PyFunceble_dev-4.0.0b19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 750a4f66a93f642d7088d718ee62b7ddeae6a54cce231b7e0317545bec516094 |
|
MD5 | 475454ae9de66e098c72bbacb4169ca0 |
|
BLAKE2b-256 | 4aeb0e553b8d1ed4390f0d18b3dee9954ee3e14d105034e6d8b96aa80fb9e436 |