The tool to check the availability or syntax of domain, IP or URL

PyFunceble 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!

Table of Content

• Installation
  • Packages & Versioning
  • PyPi - Python Package Index
    • Optional Dependencies
    • pyfunceble
    • pyfunceble-dev
  • Container Image Registry
    • pyfunceble
      • Docker Hub
    • pyfunceble-dev
      • Docker Hub
  • ArchLinux
  • Git Repository
    • pyfunceble
      • GitHub
      • GitLab
    • pyfunceble-dev
      • GitHub
      • GitLab
  • From Source
• Usage
  • Common Setups
  • Container Image Setups
    • Data Persitence
  • Common Examples
• Documentation as the place to be!
• Supporting the project
• Contributors
• Special Thanks
• License

Installation

Packages & Versioning

This project follows the semver standard.

PyFunceble is distributed through 2 packages that reflects our 2 main development and deployment branches. Both packages are stable but with 2 different phylosophies. Therefore, the choice is up to you.

The 2 packages are pyfunceble and pyfunceble-dev.

If you want a stable but mature, and slowly updating package, you should install the pyfunceble package. It reflects the master branch which only get updated once the new features and bugfixes of pyfunceble-dev are tested long enough to be considered mature.

On the other hand, if you want a stable but fast updating package, you should install the pyfunceble-dev package. It reflects the dev branch which get updated frequently to allow the community to provide feedbacks as soon as possible.

Recommendation: For most people the pyfunceble package should be sufficient. But if you want to help the community or always want to have the latest features and bugfix as soon as possible, you should prefer the pyfunceble-dev package.

PyPi - Python Package Index

Installing from the Python Package Index is for most people the prefered one - after the OS specific packages (see below).

Here is an overview of the packages and where they are hosted.

| Package | PyPi Link | | -------------- | ---------------------------------------- | | pyfunceble | https://pypi.org/project/PyFunceble | | pyfunceble-dev | https://pypi.org/project/PyFunceblee-dev |

Optional Dependencies

The following dependencies are optional and can be installed if you need them.

| Dependency | Description | | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | all | Install all functional dependencies. Basically all but dev, test and docs. When a binary and non binary version is available, the binary version is installed. | | full | Install all dependencies listed below. When a binary and non binary version is available, the binary version is installed. | | psql, postgresql | Build and install the dependencies required to interact with PostgreSQL. | | psql-binary, postgresql-binary | Install the dependencies required to interact with PostgreSQL - from binary. | | docs | Install the dependencies required to build the documentation. | | test | Install the dependencies required to run the tests. | | dev | Install the dependencies required to develop PyFunceble. |

They are intended to be installed through the following syntax:

pip3 install --user {pkg}[{dependency}]

As an example if you want to install the docs and test dependencies, you should run:

pip3 install --user pyfunceble[docs,test]

pyfunceble

You can install the pyfunceble through pip3:

pip3 install --user pyfunceble

pyfunceble-dev

You can install the pyfunceble-dev package through pip3:

pip3 install --user pyfunceble-dev

If you want to help and use the unstable pre-releases, you should install with the --pre argument.

pip3 install --user --pre pyfunceble-dev

Container Image Registry

Installing from a Container Image Registry is the way to go if you are in a hurry or always want the best from the beat without having to look if an update is available. :smile:

Here is an overview of the packages and where they are hosted.

| Host | Package | Link | | ---------- | -------------- | -------------------------------------------------------------------------------------------------------- | | Docker Hub | pyfunceble | https://hub.docker.com/r/pyfunceble/pyfunceble | | Docker Hub | pyfunceble-dev | https://hub.docker.com/r/pyfunceble/pyfunceble-dev |

pyfunceble

Docker Hub

You can install the pyfunceble image from Docker Hub through docker:

docker pull pyfunceble/pyfunceble

pyfunceble-dev

Docker Hub

You can install the pyfunceble-dev image from Docker Hub through docker:

docker pull pyfunceble/pyfunceble-dev

ArchLinux

For the pyfunceble package:

aur-helper -S pyfunceble
pyfunceble --version

For the pyfunceble-dev package:

aur-helper -S pyfunceble-dev
pyfunceble --version

Git Repository

Installing from a Git Repository with pip3 is not recommended for general user as you will get the latest development patches even before they get published. But if you are one of those who always want to be in sync with the latest development patches, this is probably for you.

Here is an overview of the packages and where they are hosted.

| Host | Package | Repository | | ------ | -------------- | ----------------------------------------------------------------------- | | GitHub | pyfunceble | git+https://github.com/funilrys/PyFunceble.git@master#egg=PyFunceble | | GitHub | pyfunceble-dev | git+https://github.com/funilrys/PyFunceble.git@dev#egg=PyFunceble-dev | | GitLab | pyfunceble | `git+https://gitlab.