PyFunceble 1.2.0

The tool to check the availability or syntax of domains, IPv4 or URL.

.. image:: https://raw.githubusercontent.com/PyFunceble/logo/master/Green/HD/RM.png

The tool to check the availability or syntax of domains, IPv4 or URL
--------------------------------------------------------------------

.. image:: https://api.travis-ci.com/funilrys/PyFunceble.png?branch=master
:target: https://travis-ci.com/funilrys/PyFunceble
.. image:: https://coveralls.io/repos/github/funilrys/PyFunceble/badge.png?branch=master
:target: https://coveralls.io/github/funilrys/PyFunceble?branch=master
.. image:: https://img.shields.io/github/license/funilrys/PyFunceble.png
:target: https://github.com/funilrys/PyFunceble/blob/master/LICENSE
.. image:: https://img.shields.io/github/release/funilrys/PyFunceble/all.png
:target: https://github.com/funilrys/PyFunceble/releases/latest
.. image:: https://img.shields.io/github/issues/funilrys/PyFunceble.png
:target: https://github.com/funilrys/PyFunceble/issues
.. image:: https://img.shields.io/badge/code%20style-black-000000.png
:target: https://github.com/ambv/black

PyFunceble is the little sister of `Funceble`_ which was archived on 13th March 2018.

Its main objective is to provide the availability of domains, IPs and since recently URL by generating an accurate result based on results from WHOIS, NSLOOKUP and HTTP status codes.

PyFunceble is currently running actively and daily with the help of Travis CI under 60+ repositories. It is used to clean or test the availability of data which are present in hosts files, list of IP, list of domains, block lists or even AdBlock filter lists.

PyFunceble provides some useful features for continuous testing.

As an example, its auto-continue system coupled with its auto-save system allows it to run nice and smoothly under Travis CI without even reaching Travis CI time restriction. In the other side, its internal inactive database system let :code:`INACTIVE` and :code:`INVALID` caught domains, IPs or URLs being automatically retested over time on next run.

___________________________________________

Documentation as the place to be!
---------------------------------

Want to know more about **PyFunceble**?
We invite you to read the documentation at https://pyfunceble.readthedocs.io/en/master/!

Want a local copy? We get you covered!

Simply run the following and enjoy the documentation!

::

$ cd docs/
$ make html
$ chromium _build/html/index.html # Chromium or whatever browser you use.

___________________________________________

What can PyFunceble do?
-----------------------

- Test of the availability of a domain.
- Test of the availability of an IPv4.
- Test of the availability of an URL.
- Test of the availability of a domain/DNS name in a private or local network.
- Test of the availability of an IPv4 in a private or local network.
- Test of the availability of an URL in a private or local network.
- Test of the syntax of a domain.
- Test of the syntax of an IPv4.
- Test of the syntax of an URL.
- Test of domain or IP which are present into an Adblock formatted file.
- Test from a given raw link.
- Save test result(s) on file(s) (hosts file, plain text and/or JSON format).
- Show test result(s) on screen.
- Show percentage of each status (:code:`ACTIVE`, :code:`INACTIVE`, :code:`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 (:code:`ACTIVE`, :code:`POTENTIALLY_ACTIVE`, :code:`POTENTIALLY_INACTIVE`, :code:`SUSPICIOUS`).
- Retest overtime of :code:`INACTIVE` and :code:`INVALID` domains.
- Print the execution time on screen and file.
- Customization of the different option via command-line arguments or configuration file.
- Continuous tests under Travis CI with the help of an auto saving and database system.

- Set branch to push the result to for the autosaving system.
- Set the minimal time before we autosave in order to avoid Travis CI limitation.
- Set a command to execute at the end of the test.
- Set the commit message for the autosaving system.

- ... and a lot more!

.. image:: https://github.com/PyFunceble/gifs/raw/master/domain.gif
:target: https://github.com/PyFunceble/gifs/raw/master/domain.gif

Please report to the `documentation for more GIF`_.

___________________________________________

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?

.. image:: https://az743702.vo.msecnd.net/cdn/kofi3.png
:target: https://ko-fi.com/V7V3EH2Y
:height: 36px

___________________________________________

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.

::

_______ _ _ _ _
|__ __| | | | | | | |
| | | |__ __ _ _ __ | | _____ | |_ ___ _ _ ___ _ _ | |
| | | '_ \ / _` | '_ \| |/ / __| | __/ _ \ | | | |/ _ \| | | | | |
| | | | | | (_| | | | | <\__ \ | || (_) | | |_| | (_) | |_| | |_|
|_| |_| |_|\__,_|_| |_|_|\_\___/ \__\___/ \__, |\___/ \__,_| (_)
__/ |
|___/

- dnmTX - `@dnmTX`_
- jawz101 - `@jawz101`_
- Mitchell Krog - `@mitchellkrogza`_
- Odyseus - `@Odyseus`_
- Reza Rizqullah - `@ybreza`_
- ScriptTiger - `@ScriptTiger`_
- speedmann - `@speedmann`_
- WaLLy3K - `@WaLLy3K`_
- xxcriticxx - `@xxcriticxx`_
___________________________________________

Special Thanks
--------------

Thanks to those awesome organization(s), tools 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`_
- Mitchell Krog - `@mitchellkrogza`_
- Mohammad Fares - `@faressoft`_
- Pi-Hole - `@pi-hole`_
- Public Suffix List - `@publicsuffix`_
- Reza Rizqullah - `@ybreza`_
- ScriptTiger - `@ScriptTiger`_
- SMed79 - `@SMed79`_
- `IANA`_ - `ICANN`_
- `yEd Graph Editor`_ - `yWorks`_

___________________________________________

License
-------
::

MIT License

Copyright (c) 2017-2018 Nissar Chababy

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

.. _Dead-Hosts: https://github.com/dead-hosts
.. _Funceble: https://github.com/funilrys/funceble
.. _IANA: https://www.iana.org/
.. _ICANN: https://www.icann.org/
.. _PyFunceble: https://github.com/funilrys/PyFunceble
.. _yEd Graph Editor: https://www.yworks.com/products/yed
.. _yWorks: https://www.yworks.com/company

.. _@adblockplus: https://github.com/adblockplus
.. _@dnmTX: https://github.com/dnmTX
.. _@faressoft: https://github.com/faressoft
.. _@jawz101: https://github.com/jawz101
.. _@mitchellkrogza: https://github.com/mitchellkrogza
.. _@Odyseus: https://github.com/Odyseus
.. _@pi-hole: https://github.com/pi-hole/pi-hole
.. _@PromoFaux: https://github.com/PromoFaux
.. _@publicsuffix: https://github.com/publicsuffix
.. _@ScriptTiger: https://github.com/ScriptTiger
.. _@SMed79: https://github.com/SMed79
.. _@speedmann: https://github.com/speedmann
.. _@Wally3K: https://github.com/WaLLy3K
.. _@xxcriticxx: https://github.com/xxcriticxx
.. _@ybreza: https://github.com/ybreza

.. _documentation for more GIF: https://pyfunceble.readthedocs.io/en/master/in-action.html