![image](https://raw.githubusercontent.com/PyFunceble/logo/dev/Green/HD/RM.png)
# The tool to check the availability or syntax of domain, IP or URL
[![image](https://img.shields.io/badge/code%20style-black-000000.png)](https://github.com/ambv/black)
[![image](https://coveralls.io/repos/github/funilrys/PyFunceble/badge.png?branch=dev)](https://coveralls.io/github/funilrys/PyFunceble?branch=dev)
[![image](https://img.shields.io/github/license/funilrys/PyFunceble.png)](https://github.com/funilrys/PyFunceble/blob/dev/LICENSE)
[![image](https://img.shields.io/pypi/v/pyfunceble-dev.png)](https://pypi.org/project/pyfunceble-dev)
[![image](https://img.shields.io/github/issues/funilrys/PyFunceble.png)](https://github.com/funilrys/PyFunceble/issues)
[![image](https://static.pepy.tech/badge/pyfunceble-dev)](https://pepy.tech/project/pyfunceble-dev)
[![image](https://static.pepy.tech/badge/pyfunceble-dev/month)](https://pepy.tech/project/pyfunceble-dev)
[![image](https://static.pepy.tech/badge/pyfunceble-dev/week)](https://pepy.tech/project/pyfunceble-dev)
**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](https://docs.pyfunceble.com/develop/getting-started.html).
- the [PyFunceble
web-worker](https://github.com/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!
[![image](https://github.com/PyFunceble/gifs/raw/master/repo-showcase.gif)](https://github.com/PyFunceble/gifs/raw/master/repo-showcase.gif)
# Table of Content
- [The tool to check the availability or syntax of domain, IP or URL](#the-tool-to-check-the-availability-or-syntax-of-domain-ip-or-url)
- [Table of Content](#table-of-content)
- [Installation](#installation)
- [Packages \& Versioning](#packages--versioning)
- [PyPi - Python Package Index](#pypi---python-package-index)
- [pyfunceble](#pyfunceble)
- [pyfunceble-dev](#pyfunceble-dev)
- [Container Image Registry](#container-image-registry)
- [pyfunceble](#pyfunceble-1)
- [Docker Hub](#docker-hub)
- [pyfunceble-dev](#pyfunceble-dev-1)
- [Docker Hub](#docker-hub-1)
- [ArchLinux](#archlinux)
- [Git Repository](#git-repository)
- [pyfunceble](#pyfunceble-2)
- [GitHub](#github)
- [GitLab](#gitlab)
- [pyfunceble-dev](#pyfunceble-dev-2)
- [GitHub](#github-1)
- [GitLab](#gitlab-1)
- [From Source](#from-source)
- [Usage](#usage)
- [Common Setups](#common-setups)
- [Container Image Setups](#container-image-setups)
- [Data Persitence](#data-persitence)
- [Common Examples](#common-examples)
- [Documentation as the place to be!](#documentation-as-the-place-to-be)
- [Supporting the project](#supporting-the-project)
- [Contributors](#contributors)
- [Special Thanks](#special-thanks)
- [License](#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 |
### pyfunceble
You can install the **pyfunceble** through `pip3`:
```shell
pip3 install --user pyfunceble
```
### pyfunceble-dev
You can install the **pyfunceble-dev** package through `pip3`:
```shell
pip3 install --user pyfunceble-dev
```
If you want to help and use the unstable pre-releases, you should install with
the `--pre` argument.
```shell
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](https://hub.docker.com/r/pyfunceble/pyfunceble) |
| Docker Hub | pyfunceble-dev | [https://hub.docker.com/r/pyfunceble/pyfunceble-dev](https://hub.docker.com/r/pyfunceble/pyfunceble-dev) |
### pyfunceble
#### Docker Hub
You can install the **pyfunceble** image from Docker Hub through `docker`:
```shell
docker pull pyfunceble/pyfunceble
```
### pyfunceble-dev
#### Docker Hub
You can install the **pyfunceble-dev** image from Docker Hub through `docker`:
```shell
docker pull pyfunceble/pyfunceble-dev
```
## ArchLinux
For the **`pyfunceble`** package:
```shell
aur-helper -S pyfunceble
pyfunceble --version
```
For the **`pyfunceble-dev`** package:
```shell
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.com/funilrys/PyFunceble.git@master#egg=PyFunceble` |
| GitLab | pyfunceble-dev | `git+https://gitlab.com/funilrys/PyFunceble.git@dev#egg=PyFunceble-dev` |
### pyfunceble
#### GitHub
You can install the **pyfunceble** package from GitHub through `pip3`:
```shell
pip3 install --user git+https://github.com/funilrys/PyFunceble.git@master#egg=PyFunceble
```
#### GitLab
You can install the **pyfunceble** package from GitLab through `pip3`:
```shell
pip3 install --user git+https://gitlab.com/funilrys/PyFunceble.git@master#egg=PyFunceble
```
### pyfunceble-dev
#### GitHub
You can install the **pyfunceble-dev** package from GitHub through `pip3`:
```shell
pip3 install --user git+https://github.com/funilrys/PyFunceble.git@dev#egg=PyFunceble-dev
```
#### GitLab
You can install the **pyfunceble-dev** package from GitLab through `pip3`:
```shell
pip3 install --user git+https://gitlab.com/funilrys/PyFunceble.git@dev#egg=PyFunceble-dev
```
## From Source
Installing from source is not recommended at all as you may need to keep the repository
up-to-date by yourself.
Here is an overview of the packages and where they are hosted.
| Host | Package | Branch | Repository |
| ------ | -------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| GitHub | pyfunceble | `master` | [https://github.com/funilrys/PyFunceble/tree/master](https://github.com/funilrys/PyFunceble/tree/master) |
| GitHub | pyfunceble-dev | `dev` | [https://github.com/funilrys/PyFunceble/tree/dev](https://github.com/funilrys/PyFunceble/tree/dev) |
| GitLab | pyfunceble | `master` | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) |
| GitLab | pyfunceble-dev | `dev` | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) |
You can install the package from source through `pip3`:
```shell
pip3 install --user https://github.com/funilrys/PyFunceble/archive/{{branch}}.zip # From Github
pip3 install --user https://gitlab.com/funilrys/PyFunceble/-/archive/{{branch}}/PyFunceble-{{branch}}.zip # From GitLab
```
# Usage
## Common Setups
If you installed PyFunceble through any other method that doesn't involve a container image, you can use PyFunceble "normally" through the `pyfunceble` executable.
```sh
pyfunceble --help
```
## Container Image Setups
If you installed PyFunceble through the container image registry method, you can run pyfunceble through:
```sh
docker run -it pyfunceble/pyfunceble[-dev] --help
```
**Beware:** if the first parameter starts with a slash (`/`), the entrypoint will assume that you want to run a command within the container.
### Data Persitence
If you wish to persist your data, you simply have to mount a volume to the `/home/pyfunceble` directory.
Example:
```sh
mkdir -p pyf-data
echo "example.com" > pyf-data/test.list
docker run -v pyf-data:/home/pyfunceble -it pyfunceble/pyfunceble[-dev] -f /home/pyf-data/test.list
```
## Common Examples
Here are some examples to get started.
Check the availability of 'example.com'.
$ pyfunceble -d example.com
Check the availability of 'example.com' with a simple (stdout) output.
$ pyfunceble -s -d example.com
Check the availability of 'example.com' with extended (stdout) output.
$ pyfunceble -a -d example.com
Check the availability of 'example.com' and 'example.org'.
$ pyfunceble -d example.com example.org
Check the availability of 'https://example.com'.
$ pyfunceble -u https://example.com
Check the availability of 'https://example.com' and 'https://example.org'.
$ pyfunceble -u https://example.com https://example.com
Check the syntax of 'example.com'.
$ pyfunceble --syntax -d example.com
Check the reputation of 'example.com'.
$ pyfunceble --reputation -d example.com
Check the availability of all subjects in the 'myhosts' file.
$ pyfunceble -f myhosts
Check the availability of all subjects in the 'myhosts' and 'yourhosts' files.
$ pyfunceble -f myhosts yourhosts
Check the availability of all (decoded) subject of the adblock filter list 'myadblock'.
$ pyfunceble --adblock -f myadblock
# Documentation as the place to be!
Want to know more about details **PyFunceble**? I invite you to read the
documentation at [docs.pyfunceble.com](https://docs.pyfunceble.com)!
Want a local copy? I get you covered!
If you want to run the documentation locally, you can do so by following the
instructions below.
Through Docker:
```shell
docker run -it -p 8080:80 pyfunceble/docs
# Open Documentation with browser: http://localhost:8080
palemoon http://127.0.0.1:8000
```
From source:
```shell
# Install dependencies.
pip install --user -r requirements.docs.txt
# Serve documentation locally.
mkdocs serve
# Open Documentation with browser.
palemoon http://127.0.0.1:8000
```
**NOTE:** You are also invited to submit changes and improvement to the
documentation through a new Pull Request.
# Supporting the project
[PyFunceble](https://github.com/funilrys/PyFunceble),
[Dead-Hosts](https://github.com/dead-hosts), [adblock-decoder](https://github.com/pyunceble/adblock-decoder)
and all other analog projects are powered by free time and a lot of coffee!
This project helps you and you have to possibility to help back financially?
Sponsor [@funilrys](https://github.com/funilrys) through the GitHub Sponsor
program by clicking the image below!
[![image](https://github.blog/de/wp-content/uploads/sites/3/2019/05/mona-heart-featured.png?w=200)](https://github.com/sponsors/funilrys)
# Contributors
Thanks to those awesome peoples for their awesome and crazy idea(s),
contribution(s) and or issue report which made or make
[PyFunceble](https://github.com/funilrys/PyFunceble) a better tool.
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="20%"><a href="https://github.com/AvinashReddy3108"><img src="https://avatars.githubusercontent.com/u/27774996?v=4?s=100" width="100px;" alt="Avinash Reddy"/><br /><sub><b>Avinash Reddy</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3AAvinashReddy3108" title="Bug reports">๐</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/bigdargon"><img src="https://avatars.githubusercontent.com/u/10969626?v=4?s=100" width="100px;" alt="BigDargon"/><br /><sub><b>BigDargon</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Abigdargon" title="Bug reports">๐</a> <a href="#ideas-bigdargon" title="Ideas, Planning, & Feedback">๐ค</a> <a href="#question-bigdargon" title="Answering Questions">๐ฌ</a> <a href="https://github.com/funilrys/PyFunceble/pulls?q=is%3Apr+reviewed-by%3Abigdargon" title="Reviewed Pull Requests">๐</a> <a href="#data-bigdargon" title="Data">๐ฃ</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=bigdargon" title="Tests">โ ๏ธ</a></td>
<td align="center" valign="top" width="20%"><a href="http://www.fanboy.co.nz/"><img src="https://avatars.githubusercontent.com/u/1659004?v=4?s=100" width="100px;" alt="Fanboynz"/><br /><sub><b>Fanboynz</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Aryanbr" title="Bug reports">๐</a> <a href="#ideas-ryanbr" title="Ideas, Planning, & Feedback">๐ค</a> <a href="#financial-ryanbr" title="Financial">๐ต</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=ryanbr" title="Tests">โ ๏ธ</a> <a href="#userTesting-ryanbr" title="User Testing">๐</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/veracioux"><img src="https://avatars.githubusercontent.com/u/29044423?v=4?s=100" width="100px;" alt="Haris Guลกiฤ"/><br /><sub><b>Haris Guลกiฤ</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/commits?author=veracioux" title="Documentation">๐</a> <a href="#a11y-veracioux" title="Accessibility">๏ธ๏ธ๏ธ๏ธโฟ๏ธ</a> <a href="#tool-veracioux" title="Tools">๐ง</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=veracioux" title="Tests">โ ๏ธ</a> <a href="#video-veracioux" title="Videos">๐น</a> <a href="#tutorial-veracioux" title="Tutorials">โ
</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=veracioux" title="Code">๐ป</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/DandelionSprout"><img src="https://avatars.githubusercontent.com/u/22780683?v=4?s=100" width="100px;" alt="Imre Eilertsen"/><br /><sub><b>Imre Eilertsen</b></sub></a><br /><a href="#a11y-DandelionSprout" title="Accessibility">๏ธ๏ธ๏ธ๏ธโฟ๏ธ</a> <a href="https://github.com/funilrys/PyFunceble/issues?q=author%3ADandelionSprout" title="Bug reports">๐</a> <a href="#data-DandelionSprout" title="Data">๐ฃ</a> <a href="#example-DandelionSprout" title="Examples">๐ก</a> <a href="#financial-DandelionSprout" title="Financial">๐ต</a> <a href="#ideas-DandelionSprout" title="Ideas, Planning, & Feedback">๐ค</a> <a href="#promotion-DandelionSprout" title="Promotion">๐ฃ</a> <a href="#question-DandelionSprout" title="Answering Questions">๐ฌ</a> <a href="https://github.com/funilrys/PyFunceble/pulls?q=is%3Apr+reviewed-by%3ADandelionSprout" title="Reviewed Pull Requests">๐</a> <a href="#tool-DandelionSprout" title="Tools">๐ง</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=DandelionSprout" title="Tests">โ ๏ธ</a> <a href="#userTesting-DandelionSprout" title="User Testing">๐</a></td>
</tr>
<tr>
<td align="center" valign="top" width="20%"><a href="https://github.com/kowith337"><img src="https://avatars.githubusercontent.com/u/16535467?v=4?s=100" width="100px;" alt="Kowith Singkornkeeree"/><br /><sub><b>Kowith Singkornkeeree</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Akowith337" title="Bug reports">๐</a></td>
<td align="center" valign="top" width="20%"><a href="https://ubuntu101.co.za/"><img src="https://avatars.githubusercontent.com/u/9961541?v=4?s=100" width="100px;" alt="Mitchell Krog"/><br /><sub><b>Mitchell Krog</b></sub></a><br /><a href="#a11y-mitchellkrogza" title="Accessibility">๏ธ๏ธ๏ธ๏ธโฟ๏ธ</a> <a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Amitchellkrogza" title="Bug reports">๐</a> <a href="#blog-mitchellkrogza" title="Blogposts">๐</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=mitchellkrogza" title="Code">๐ป</a> <a href="#content-mitchellkrogza" title="Content">๐</a> <a href="#data-mitchellkrogza" title="Data">๐ฃ</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=mitchellkrogza" title="Documentation">๐</a> <a href="#design-mitchellkrogza" title="Design">๐จ</a> <a href="#example-mitchellkrogza" title="Examples">๐ก</a> <a href="#fundingFinding-mitchellkrogza" title="Funding Finding">๐</a> <a href="#ideas-mitchellkrogza" title="Ideas, Planning, & Feedback">๐ค</a> <a href="#infra-mitchellkrogza" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="#mentoring-mitchellkrogza" title="Mentoring">๐งโ๐ซ</a> <a href="#platform-mitchellkrogza" title="Packaging/porting to new platform">๐ฆ</a> <a href="#plugin-mitchellkrogza" title="Plugin/utility libraries">๐</a> <a href="#promotion-mitchellkrogza" title="Promotion">๐ฃ</a> <a href="#question-mitchellkrogza" title="Answering Questions">๐ฌ</a> <a href="https://github.com/funilrys/PyFunceble/pulls?q=is%3Apr+reviewed-by%3Amitchellkrogza" title="Reviewed Pull Requests">๐</a> <a href="#tool-mitchellkrogza" title="Tools">๐ง</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=mitchellkrogza" title="Tests">โ ๏ธ</a> <a href="#tutorial-mitchellkrogza" title="Tutorials">โ
</a> <a href="#talk-mitchellkrogza" title="Talks">๐ข</a> <a href="#userTesting-mitchellkrogza" title="User Testing">๐</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/Nilsonfsilva"><img src="https://avatars.githubusercontent.com/u/91392383?v=4?s=100" width="100px;" alt="Nilsonfsilva"/><br /><sub><b>Nilsonfsilva</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3ANilsonfsilva" title="Bug reports">๐</a> <a href="#infra-Nilsonfsilva" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="#platform-Nilsonfsilva" title="Packaging/porting to new platform">๐ฆ</a> <a href="#tool-Nilsonfsilva" title="Tools">๐ง</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=Nilsonfsilva" title="Tests">โ ๏ธ</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/Odyseus"><img src="https://avatars.githubusercontent.com/u/3822556?v=4?s=100" width="100px;" alt="Odyseus"/><br /><sub><b>Odyseus</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3AOdyseus" title="Bug reports">๐</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=Odyseus" title="Tests">โ ๏ธ</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/ybreza"><img src="https://avatars.githubusercontent.com/u/35470865?v=4?s=100" width="100px;" alt="Reza Rizqullah"/><br /><sub><b>Reza Rizqullah</b></sub></a><br /><a href="#design-ybreza" title="Design">๐จ</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=ybreza" title="Code">๐ป</a></td>
</tr>
<tr>
<td align="center" valign="top" width="20%"><a href="https://scripttiger.github.io/"><img src="https://avatars.githubusercontent.com/u/29940916?v=4?s=100" width="100px;" alt="ScriptTiger"/><br /><sub><b>ScriptTiger</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3AScriptTiger" title="Bug reports">๐</a> <a href="#ideas-ScriptTiger" title="Ideas, Planning, & Feedback">๐ค</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=ScriptTiger" title="Tests">โ ๏ธ</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/sjhgvr"><img src="https://avatars.githubusercontent.com/u/51121527?v=4?s=100" width="100px;" alt="Stephan van Ruth"/><br /><sub><b>Stephan van Ruth</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Asjhgvr" title="Bug reports">๐</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=sjhgvr" title="Tests">โ ๏ธ</a></td>
<td align="center" valign="top" width="20%"><a href="http://stevenblack.com/"><img src="https://avatars.githubusercontent.com/u/80144?v=4?s=100" width="100px;" alt="Steven Black"/><br /><sub><b>Steven Black</b></sub></a><br /><a href="#ideas-StevenBlack" title="Ideas, Planning, & Feedback">๐ค</a> <a href="#financial-StevenBlack" title="Financial">๐ต</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/T145"><img src="https://avatars.githubusercontent.com/u/1214129?v=4?s=100" width="100px;" alt="T145"/><br /><sub><b>T145</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3AT145" title="Bug reports">๐</a> <a href="#ideas-T145" title="Ideas, Planning, & Feedback">๐ค</a></td>
<td align="center" valign="top" width="20%"><a href="https://infosec.exchange/@wally3k"><img src="https://avatars.githubusercontent.com/u/3049142?v=4?s=100" width="100px;" alt="WaLLy3K"/><br /><sub><b>WaLLy3K</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3AWaLLy3K" title="Bug reports">๐</a> <a href="#ideas-WaLLy3K" title="Ideas, Planning, & Feedback">๐ค</a></td>
</tr>
<tr>
<td align="center" valign="top" width="20%"><a href="https://github.com/Yuki2718"><img src="https://avatars.githubusercontent.com/u/58900598?v=4?s=100" width="100px;" alt="Yuki2718"/><br /><sub><b>Yuki2718</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3AYuki2718" title="Bug reports">๐</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=Yuki2718" title="Tests">โ ๏ธ</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/Zachinquarantine"><img src="https://avatars.githubusercontent.com/u/69423184?v=4?s=100" width="100px;" alt="Zachinquarantine"/><br /><sub><b>Zachinquarantine</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/commits?author=Zachinquarantine" title="Code">๐ป</a></td>
<td align="center" valign="top" width="20%"><a href="http://bit.ly/cBWeb"><img src="https://avatars.githubusercontent.com/u/28985171?v=4?s=100" width="100px;" alt="ZeroDot1"/><br /><sub><b>ZeroDot1</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3AZeroDot1" title="Bug reports">๐</a> <a href="#ideas-ZeroDot1" title="Ideas, Planning, & Feedback">๐ค</a> <a href="#question-ZeroDot1" title="Answering Questions">๐ฌ</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=ZeroDot1" title="Tests">โ ๏ธ</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=ZeroDot1" title="Code">๐ป</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/avatartw"><img src="https://avatars.githubusercontent.com/u/69660730?v=4?s=100" width="100px;" alt="avatartw"/><br /><sub><b>avatartw</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Aavatartw" title="Bug reports">๐</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/dnmTX"><img src="https://avatars.githubusercontent.com/u/34774426?v=4?s=100" width="100px;" alt="dnmTX"/><br /><sub><b>dnmTX</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3AdnmTX" title="Bug reports">๐</a> <a href="#ideas-dnmTX" title="Ideas, Planning, & Feedback">๐ค</a> <a href="#question-dnmTX" title="Answering Questions">๐ฌ</a> <a href="https://github.com/funilrys/PyFunceble/pulls?q=is%3Apr+reviewed-by%3AdnmTX" title="Reviewed Pull Requests">๐</a> <a href="#data-dnmTX" title="Data">๐ฃ</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=dnmTX" title="Tests">โ ๏ธ</a></td>
</tr>
<tr>
<td align="center" valign="top" width="20%"><a href="https://github.com/gwarser"><img src="https://avatars.githubusercontent.com/u/886325?v=4?s=100" width="100px;" alt="gwarser"/><br /><sub><b>gwarser</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Agwarser" title="Bug reports">๐</a> <a href="#data-gwarser" title="Data">๐ฃ</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=gwarser" title="Tests">โ ๏ธ</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/hawkeye116477"><img src="https://avatars.githubusercontent.com/u/19818572?v=4?s=100" width="100px;" alt="hawkeye116477"/><br /><sub><b>hawkeye116477</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Ahawkeye116477" title="Bug reports">๐</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/jawz101"><img src="https://avatars.githubusercontent.com/u/14151703?v=4?s=100" width="100px;" alt="jawz101"/><br /><sub><b>jawz101</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Ajawz101" title="Bug reports">๐</a> <a href="#ideas-jawz101" title="Ideas, Planning, & Feedback">๐ค</a> <a href="#question-jawz101" title="Answering Questions">๐ฌ</a> <a href="#data-jawz101" title="Data">๐ฃ</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/keczuppp"><img src="https://avatars.githubusercontent.com/u/74409207?v=4?s=100" width="100px;" alt="keczuppp"/><br /><sub><b>keczuppp</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Akeczuppp" title="Bug reports">๐</a> <a href="#ideas-keczuppp" title="Ideas, Planning, & Feedback">๐ค</a> <a href="#question-keczuppp" title="Answering Questions">๐ฌ</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=keczuppp" title="Tests">โ ๏ธ</a> <a href="#data-keczuppp" title="Data">๐ฃ</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/opav"><img src="https://avatars.githubusercontent.com/u/6770347?v=4?s=100" width="100px;" alt="opav"/><br /><sub><b>opav</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Aopav" title="Bug reports">๐</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=opav" title="Tests">โ ๏ธ</a></td>
</tr>
<tr>
<td align="center" valign="top" width="20%"><a href="https://github.com/rusty-snake"><img src="https://avatars.githubusercontent.com/u/41237666?v=4?s=100" width="100px;" alt="rusty-snake"/><br /><sub><b>rusty-snake</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Arusty-snake" title="Bug reports">๐</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=rusty-snake" title="Documentation">๐</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/smed79"><img src="https://avatars.githubusercontent.com/u/1873139?v=4?s=100" width="100px;" alt="smed79"/><br /><sub><b>smed79</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Asmed79" title="Bug reports">๐</a> <a href="#ideas-smed79" title="Ideas, Planning, & Feedback">๐ค</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=smed79" title="Code">๐ป</a> <a href="#question-smed79" title="Answering Questions">๐ฌ</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=smed79" title="Tests">โ ๏ธ</a></td>
<td align="center" valign="top" width="20%"><a href="https://speedmann.de/"><img src="https://avatars.githubusercontent.com/u/424659?v=4?s=100" width="100px;" alt="speedmann"/><br /><sub><b>speedmann</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Aspeedmann" title="Bug reports">๐</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=speedmann" title="Tests">โ ๏ธ</a></td>
<td align="center" valign="top" width="20%"><a href="https://www.mypdns.org/"><img src="https://avatars.githubusercontent.com/u/44526987?v=4?s=100" width="100px;" alt="spirillen"/><br /><sub><b>spirillen</b></sub></a><br /><a href="#a11y-spirillen" title="Accessibility">๏ธ๏ธ๏ธ๏ธโฟ๏ธ</a> <a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Aspirillen" title="Bug reports">๐</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=spirillen" title="Code">๐ป</a> <a href="#content-spirillen" title="Content">๐</a> <a href="#data-spirillen" title="Data">๐ฃ</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=spirillen" title="Documentation">๐</a> <a href="#example-spirillen" title="Examples">๐ก</a> <a href="#ideas-spirillen" title="Ideas, Planning, & Feedback">๐ค</a> <a href="#maintenance-spirillen" title="Maintenance">๐ง</a> <a href="#mentoring-spirillen" title="Mentoring">๐งโ๐ซ</a> <a href="#promotion-spirillen" title="Promotion">๐ฃ</a> <a href="#question-spirillen" title="Answering Questions">๐ฌ</a> <a href="https://github.com/funilrys/PyFunceble/pulls?q=is%3Apr+reviewed-by%3Aspirillen" title="Reviewed Pull Requests">๐</a> <a href="#tool-spirillen" title="Tools">๐ง</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=spirillen" title="Tests">โ ๏ธ</a> <a href="#tutorial-spirillen" title="Tutorials">โ
</a> <a href="#talk-spirillen" title="Talks">๐ข</a> <a href="#userTesting-spirillen" title="User Testing">๐</a></td>
<td align="center" valign="top" width="20%"><a href="https://github.com/NeolithEra"><img src="https://avatars.githubusercontent.com/u/52778917?v=4?s=100" width="100px;" alt="watchman-pypi"/><br /><sub><b>watchman-pypi</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3ANeolithEra" title="Bug reports">๐</a></td>
</tr>
<tr>
<td align="center" valign="top" width="20%"><a href="https://github.com/xxcriticxx"><img src="https://avatars.githubusercontent.com/u/15007183?v=4?s=100" width="100px;" alt="xxcriticxx"/><br /><sub><b>xxcriticxx</b></sub></a><br /><a href="https://github.com/funilrys/PyFunceble/issues?q=author%3Axxcriticxx" title="Bug reports">๐</a> <a href="#ideas-xxcriticxx" title="Ideas, Planning, & Feedback">๐ค</a> <a href="https://github.com/funilrys/PyFunceble/commits?author=xxcriticxx" title="Tests">โ ๏ธ</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
# 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](https://github.com/funilrys/PyFunceble) a better tool.
- Adam Warner - [@PromoFaux](https://github.com/PromoFaux)
- Adblock Plus - [@adblockplus](https://github.com/adblockplus)
- asciinema - [@asciinema](https://github.com/asciinema)
- Bob Halley - [@rthalley](https://github.com/rthalley)
([DNSPython](https://github.com/rthalley/dnspython))
- Chris Griffith - [@cdgriffith](https://github.com/cdgriffith)
([Box](https://github.com/cdgriffith/Box))
- Daniel - [@dnmTX](https://github.com/dnmTX)
- Jonathan Hartley - [@tartley](https://github.com/tartley)
([colorama](https://github.com/tartley/colorama))
- [IANA](https://www.iana.org/) - [ICANN](https://www.icann.org/)
([Root Zone Database](https://www.iana.org/domains/root/db))
- [Iterative](https://github.com/iterative)
([shtab](https://github.com/iterative/shtab))
- Kenneth Reitz - [@kennethreitz](https://github.com/kennethreitz)
([requests](https://github.com/kennethreitz/requests))
- Mitchell Krog - [@mitchellkrogza](https://github.com/mitchellkrogza)
- Mohammad Fares - [@faressoft](https://github.com/faressoft)
([Terminalizer](https://github.com/faressoft/terminalizer))
- Pi-Hole - [@pi-hole](https://github.com/pi-hole/pi-hole)
- Public Suffix List -
[@publicsuffix](https://github.com/publicsuffix)
- Reza Rizqullah - [@ybreza](https://github.com/ybreza)
- Saurabh Kumar - [@theskumar](https://github.com/theskumar)
([python-dotenv](https://github.com/theskumar/python-dotenv))
- ScriptTiger - [@ScriptTiger](https://github.com/ScriptTiger)
- SMed79 - [@SMed79](https://github.com/SMed79)
- spirillen - [@spirillen](https://www.mypdns.org/p/Spirillen/)
- The YAML Project - [@yaml](https://github.com/yaml)
([pyyaml](https://github.com/yaml/pyyaml))
- [yWorks](https://www.yworks.com) - ([yEd Graph
Editor](https://www.yworks.com/products/yed))
# License
Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 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
https://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.
Raw data
{
"_id": null,
"home_page": "https://github.com/funilrys/PyFunceble",
"name": "PyFunceble-dev",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "PyFunceble, syntax-checker, reputation-checker, availability-checker",
"author": "funilrys",
"author_email": "contact@funilrys.com",
"download_url": "https://files.pythonhosted.org/packages/6f/47/4206eed817dea73485644c5541ad3d971c823cbf5f67dd50b3e61c713558/pyfunceble_dev-4.2.29.tar.gz",
"platform": "any",
"description": "![image](https://raw.githubusercontent.com/PyFunceble/logo/dev/Green/HD/RM.png)\n\n# The tool to check the availability or syntax of domain, IP or URL\n\n[![image](https://img.shields.io/badge/code%20style-black-000000.png)](https://github.com/ambv/black)\n[![image](https://coveralls.io/repos/github/funilrys/PyFunceble/badge.png?branch=dev)](https://coveralls.io/github/funilrys/PyFunceble?branch=dev)\n[![image](https://img.shields.io/github/license/funilrys/PyFunceble.png)](https://github.com/funilrys/PyFunceble/blob/dev/LICENSE)\n[![image](https://img.shields.io/pypi/v/pyfunceble-dev.png)](https://pypi.org/project/pyfunceble-dev)\n[![image](https://img.shields.io/github/issues/funilrys/PyFunceble.png)](https://github.com/funilrys/PyFunceble/issues)\n\n[![image](https://static.pepy.tech/badge/pyfunceble-dev)](https://pepy.tech/project/pyfunceble-dev)\n[![image](https://static.pepy.tech/badge/pyfunceble-dev/month)](https://pepy.tech/project/pyfunceble-dev)\n[![image](https://static.pepy.tech/badge/pyfunceble-dev/week)](https://pepy.tech/project/pyfunceble-dev)\n\n**PyFunceble** aims to provide an accurate availability check through\nthe usage of multiple sources which are for example - to only list a\nfew:\n\n- the WHOIS record(s).\n- the DNS record(s).\n- the HTTP status code.\n\nPyFunceble can be included in your existing project through:\n\n- its standard built-in CLI implementation.\n- its [Python\n API](https://docs.pyfunceble.com/develop/getting-started.html).\n- the [PyFunceble\n web-worker](https://github.com/pyfunceble/web-worker) project that\n provides the core functionalities of PyFunceble behind a web API.\n\nThe PyFunceble CLI can test from a hosts file, a plain list of subjects,\nan AdBlock filter list or even an RPZ record.\n\nAs of today, PyFunceble is running actively - if not daily - within\nseveral servers, laptops, PCs, and Raspberry Pis. It is even used -\nthanks to our auto continue mechanism - with CI engines like GitHub\nAction, Travis CI, or GitLab CI.\n\nHappy testing with PyFunceble!\n\n[![image](https://github.com/PyFunceble/gifs/raw/master/repo-showcase.gif)](https://github.com/PyFunceble/gifs/raw/master/repo-showcase.gif)\n\n# Table of Content\n\n- [The tool to check the availability or syntax of domain, IP or URL](#the-tool-to-check-the-availability-or-syntax-of-domain-ip-or-url)\n- [Table of Content](#table-of-content)\n- [Installation](#installation)\n - [Packages \\& Versioning](#packages--versioning)\n - [PyPi - Python Package Index](#pypi---python-package-index)\n - [pyfunceble](#pyfunceble)\n - [pyfunceble-dev](#pyfunceble-dev)\n - [Container Image Registry](#container-image-registry)\n - [pyfunceble](#pyfunceble-1)\n - [Docker Hub](#docker-hub)\n - [pyfunceble-dev](#pyfunceble-dev-1)\n - [Docker Hub](#docker-hub-1)\n - [ArchLinux](#archlinux)\n - [Git Repository](#git-repository)\n - [pyfunceble](#pyfunceble-2)\n - [GitHub](#github)\n - [GitLab](#gitlab)\n - [pyfunceble-dev](#pyfunceble-dev-2)\n - [GitHub](#github-1)\n - [GitLab](#gitlab-1)\n - [From Source](#from-source)\n- [Usage](#usage)\n - [Common Setups](#common-setups)\n - [Container Image Setups](#container-image-setups)\n - [Data Persitence](#data-persitence)\n - [Common Examples](#common-examples)\n- [Documentation as the place to be!](#documentation-as-the-place-to-be)\n- [Supporting the project](#supporting-the-project)\n- [Contributors](#contributors)\n- [Special Thanks](#special-thanks)\n- [License](#license)\n\n\n# Installation\n\n## Packages & Versioning\n\nThis project follows the semver standard.\n\nPyFunceble is distributed through 2 packages that reflects our 2 main development and\ndeployment branches. Both packages are stable but with 2 different phylosophies.\nTherefore, the choice is up to you.\n\nThe 2 packages are `pyfunceble` and `pyfunceble-dev`.\n\nIf you want a **stable** but **mature**, and **slowly** updating package, you\nshould install the `pyfunceble` package.\nIt reflects the `master` branch which only get updated once the new features and\nbugfixes of `pyfunceble-dev` are tested long enough to be considered mature.\n\nOn the other hand, if you want a **stable** but **fast** updating package, you\nshould install the `pyfunceble-dev` package.\nIt reflects the `dev` branch which get updated frequently to allow the community to\nprovide feedbacks as soon as possible.\n\n**Recommendation:**\nFor most people the `pyfunceble` package should be sufficient. But if you want to help\nthe community or always want to have the latest features and bugfix as soon as possible,\nyou should prefer the `pyfunceble-dev` package.\n\n## PyPi - Python Package Index\n\nInstalling from the Python Package Index is for most people the prefered one - after\nthe OS specific packages _(see below)_.\n\nHere is an overview of the packages and where they are hosted.\n\n| Package | PyPi Link |\n|----------------|------------------------------------------|\n| pyfunceble | https://pypi.org/project/PyFunceble |\n| pyfunceble-dev | https://pypi.org/project/PyFunceblee-dev |\n\n### pyfunceble\n\nYou can install the **pyfunceble** through `pip3`:\n\n```shell\npip3 install --user pyfunceble\n```\n\n### pyfunceble-dev\n\nYou can install the **pyfunceble-dev** package through `pip3`:\n\n```shell\npip3 install --user pyfunceble-dev\n```\n\nIf you want to help and use the unstable pre-releases, you should install with\nthe `--pre` argument.\n\n```shell\npip3 install --user --pre pyfunceble-dev\n```\n\n## Container Image Registry\n\nInstalling from a Container Image Registry is the way to go if you are in a\nhurry or always want the best from the beat without having to look if an update\nis available. :smile:\n\nHere is an overview of the packages and where they are hosted.\n\n| Host | Package | Link |\n|------------|----------------|----------------------------------------------------------------------------------------------------------|\n| Docker Hub | pyfunceble | [https://hub.docker.com/r/pyfunceble/pyfunceble](https://hub.docker.com/r/pyfunceble/pyfunceble) |\n| Docker Hub | pyfunceble-dev | [https://hub.docker.com/r/pyfunceble/pyfunceble-dev](https://hub.docker.com/r/pyfunceble/pyfunceble-dev) |\n\n### pyfunceble\n\n#### Docker Hub\n\nYou can install the **pyfunceble** image from Docker Hub through `docker`:\n\n```shell\ndocker pull pyfunceble/pyfunceble\n```\n\n### pyfunceble-dev\n\n#### Docker Hub\n\nYou can install the **pyfunceble-dev** image from Docker Hub through `docker`:\n\n```shell\ndocker pull pyfunceble/pyfunceble-dev\n```\n\n## ArchLinux\n\nFor the **`pyfunceble`** package:\n\n```shell\naur-helper -S pyfunceble\npyfunceble --version\n```\n\nFor the **`pyfunceble-dev`** package:\n\n```shell\naur-helper -S pyfunceble-dev\npyfunceble --version\n```\n\n## Git Repository\n\nInstalling from a Git Repository with `pip3` is not recommended for general user as\nyou will get the latest development patches even before they get published. But if you\nare one of those who always want to be in sync with the latest development patches,\nthis is probably for you.\n\nHere is an overview of the packages and where they are hosted.\n\n| Host | Package | Repository |\n|--------|----------------|-------------------------------------------------------------------------|\n| GitHub | pyfunceble | `git+https://github.com/funilrys/PyFunceble.git@master#egg=PyFunceble` |\n| GitHub | pyfunceble-dev | `git+https://github.com/funilrys/PyFunceble.git@dev#egg=PyFunceble-dev` |\n| GitLab | pyfunceble | `git+https://gitlab.com/funilrys/PyFunceble.git@master#egg=PyFunceble` |\n| GitLab | pyfunceble-dev | `git+https://gitlab.com/funilrys/PyFunceble.git@dev#egg=PyFunceble-dev` |\n\n### pyfunceble\n\n#### GitHub\n\nYou can install the **pyfunceble** package from GitHub through `pip3`:\n\n```shell\npip3 install --user git+https://github.com/funilrys/PyFunceble.git@master#egg=PyFunceble\n```\n\n#### GitLab\n\nYou can install the **pyfunceble** package from GitLab through `pip3`:\n\n```shell\npip3 install --user git+https://gitlab.com/funilrys/PyFunceble.git@master#egg=PyFunceble\n```\n\n### pyfunceble-dev\n\n#### GitHub\n\nYou can install the **pyfunceble-dev** package from GitHub through `pip3`:\n\n```shell\npip3 install --user git+https://github.com/funilrys/PyFunceble.git@dev#egg=PyFunceble-dev\n```\n\n#### GitLab\n\nYou can install the **pyfunceble-dev** package from GitLab through `pip3`:\n\n```shell\npip3 install --user git+https://gitlab.com/funilrys/PyFunceble.git@dev#egg=PyFunceble-dev\n```\n\n## From Source\n\nInstalling from source is not recommended at all as you may need to keep the repository\nup-to-date by yourself.\n\nHere is an overview of the packages and where they are hosted.\n\n| Host | Package | Branch | Repository |\n| ------ | -------------- | -------- | -------------------------------------------------------------------------------------------------------- |\n| GitHub | pyfunceble | `master` | [https://github.com/funilrys/PyFunceble/tree/master](https://github.com/funilrys/PyFunceble/tree/master) |\n| GitHub | pyfunceble-dev | `dev` | [https://github.com/funilrys/PyFunceble/tree/dev](https://github.com/funilrys/PyFunceble/tree/dev) |\n| GitLab | pyfunceble | `master` | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) |\n| GitLab | pyfunceble-dev | `dev` | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) |\n\nYou can install the package from source through `pip3`:\n\n```shell\npip3 install --user https://github.com/funilrys/PyFunceble/archive/{{branch}}.zip # From Github\npip3 install --user https://gitlab.com/funilrys/PyFunceble/-/archive/{{branch}}/PyFunceble-{{branch}}.zip # From GitLab\n```\n\n# Usage\n\n## Common Setups\n\nIf you installed PyFunceble through any other method that doesn't involve a container image, you can use PyFunceble \"normally\" through the `pyfunceble` executable.\n\n```sh\npyfunceble --help\n```\n\n\n## Container Image Setups\n\n\nIf you installed PyFunceble through the container image registry method, you can run pyfunceble through:\n\n```sh\ndocker run -it pyfunceble/pyfunceble[-dev] --help\n```\n\n**Beware:** if the first parameter starts with a slash (`/`), the entrypoint will assume that you want to run a command within the container.\n\n### Data Persitence\n\nIf you wish to persist your data, you simply have to mount a volume to the `/home/pyfunceble` directory.\n\nExample:\n\n```sh\nmkdir -p pyf-data\necho \"example.com\" > pyf-data/test.list\n\ndocker run -v pyf-data:/home/pyfunceble -it pyfunceble/pyfunceble[-dev] -f /home/pyf-data/test.list\n```\n\n\n## Common Examples\n\nHere are some examples to get started.\n\nCheck the availability of 'example.com'.\n\n $ pyfunceble -d example.com\n\nCheck the availability of 'example.com' with a simple (stdout) output.\n\n $ pyfunceble -s -d example.com\n\nCheck the availability of 'example.com' with extended (stdout) output.\n\n $ pyfunceble -a -d example.com\n\nCheck the availability of 'example.com' and 'example.org'.\n\n $ pyfunceble -d example.com example.org\n\nCheck the availability of 'https://example.com'.\n\n $ pyfunceble -u https://example.com\n\nCheck the availability of 'https://example.com' and 'https://example.org'.\n\n $ pyfunceble -u https://example.com https://example.com\n\nCheck the syntax of 'example.com'.\n\n $ pyfunceble --syntax -d example.com\n\nCheck the reputation of 'example.com'.\n\n $ pyfunceble --reputation -d example.com\n\nCheck the availability of all subjects in the 'myhosts' file.\n\n $ pyfunceble -f myhosts\n\nCheck the availability of all subjects in the 'myhosts' and 'yourhosts' files.\n\n $ pyfunceble -f myhosts yourhosts\n\nCheck the availability of all (decoded) subject of the adblock filter list 'myadblock'.\n\n $ pyfunceble --adblock -f myadblock\n\n# Documentation as the place to be!\n\nWant to know more about details **PyFunceble**? I invite you to read the\ndocumentation at [docs.pyfunceble.com](https://docs.pyfunceble.com)!\n\nWant a local copy? I get you covered!\n\nIf you want to run the documentation locally, you can do so by following the\ninstructions below.\n\nThrough Docker:\n\n```shell\ndocker run -it -p 8080:80 pyfunceble/docs\n# Open Documentation with browser: http://localhost:8080\npalemoon http://127.0.0.1:8000\n```\n\nFrom source:\n\n```shell\n# Install dependencies.\npip install --user -r requirements.docs.txt\n# Serve documentation locally.\nmkdocs serve\n# Open Documentation with browser.\npalemoon http://127.0.0.1:8000\n```\n\n**NOTE:** You are also invited to submit changes and improvement to the\ndocumentation through a new Pull Request.\n\n# Supporting the project\n\n[PyFunceble](https://github.com/funilrys/PyFunceble),\n[Dead-Hosts](https://github.com/dead-hosts), [adblock-decoder](https://github.com/pyunceble/adblock-decoder)\nand all other analog projects are powered by free time and a lot of coffee!\n\nThis project helps you and you have to possibility to help back financially?\nSponsor [@funilrys](https://github.com/funilrys) through the GitHub Sponsor\nprogram by clicking the image below!\n\n[![image](https://github.blog/de/wp-content/uploads/sites/3/2019/05/mona-heart-featured.png?w=200)](https://github.com/sponsors/funilrys)\n\n# Contributors\n\nThanks to those awesome peoples for their awesome and crazy idea(s),\ncontribution(s) and or issue report which made or make\n[PyFunceble](https://github.com/funilrys/PyFunceble) a better tool.\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n <tbody>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/AvinashReddy3108\"><img src=\"https://avatars.githubusercontent.com/u/27774996?v=4?s=100\" width=\"100px;\" alt=\"Avinash Reddy\"/><br /><sub><b>Avinash Reddy</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3AAvinashReddy3108\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/bigdargon\"><img src=\"https://avatars.githubusercontent.com/u/10969626?v=4?s=100\" width=\"100px;\" alt=\"BigDargon\"/><br /><sub><b>BigDargon</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Abigdargon\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#ideas-bigdargon\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#question-bigdargon\" title=\"Answering Questions\">\ud83d\udcac</a> <a href=\"https://github.com/funilrys/PyFunceble/pulls?q=is%3Apr+reviewed-by%3Abigdargon\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a> <a href=\"#data-bigdargon\" title=\"Data\">\ud83d\udd23</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=bigdargon\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"http://www.fanboy.co.nz/\"><img src=\"https://avatars.githubusercontent.com/u/1659004?v=4?s=100\" width=\"100px;\" alt=\"Fanboynz\"/><br /><sub><b>Fanboynz</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Aryanbr\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#ideas-ryanbr\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#financial-ryanbr\" title=\"Financial\">\ud83d\udcb5</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=ryanbr\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"#userTesting-ryanbr\" title=\"User Testing\">\ud83d\udcd3</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/veracioux\"><img src=\"https://avatars.githubusercontent.com/u/29044423?v=4?s=100\" width=\"100px;\" alt=\"Haris Gu\u0161i\u0107\"/><br /><sub><b>Haris Gu\u0161i\u0107</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/commits?author=veracioux\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#a11y-veracioux\" title=\"Accessibility\">\ufe0f\ufe0f\ufe0f\ufe0f\u267f\ufe0f</a> <a href=\"#tool-veracioux\" title=\"Tools\">\ud83d\udd27</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=veracioux\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"#video-veracioux\" title=\"Videos\">\ud83d\udcf9</a> <a href=\"#tutorial-veracioux\" title=\"Tutorials\">\u2705</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=veracioux\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/DandelionSprout\"><img src=\"https://avatars.githubusercontent.com/u/22780683?v=4?s=100\" width=\"100px;\" alt=\"Imre Eilertsen\"/><br /><sub><b>Imre Eilertsen</b></sub></a><br /><a href=\"#a11y-DandelionSprout\" title=\"Accessibility\">\ufe0f\ufe0f\ufe0f\ufe0f\u267f\ufe0f</a> <a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3ADandelionSprout\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#data-DandelionSprout\" title=\"Data\">\ud83d\udd23</a> <a href=\"#example-DandelionSprout\" title=\"Examples\">\ud83d\udca1</a> <a href=\"#financial-DandelionSprout\" title=\"Financial\">\ud83d\udcb5</a> <a href=\"#ideas-DandelionSprout\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#promotion-DandelionSprout\" title=\"Promotion\">\ud83d\udce3</a> <a href=\"#question-DandelionSprout\" title=\"Answering Questions\">\ud83d\udcac</a> <a href=\"https://github.com/funilrys/PyFunceble/pulls?q=is%3Apr+reviewed-by%3ADandelionSprout\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a> <a href=\"#tool-DandelionSprout\" title=\"Tools\">\ud83d\udd27</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=DandelionSprout\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"#userTesting-DandelionSprout\" title=\"User Testing\">\ud83d\udcd3</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/kowith337\"><img src=\"https://avatars.githubusercontent.com/u/16535467?v=4?s=100\" width=\"100px;\" alt=\"Kowith Singkornkeeree\"/><br /><sub><b>Kowith Singkornkeeree</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Akowith337\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://ubuntu101.co.za/\"><img src=\"https://avatars.githubusercontent.com/u/9961541?v=4?s=100\" width=\"100px;\" alt=\"Mitchell Krog\"/><br /><sub><b>Mitchell Krog</b></sub></a><br /><a href=\"#a11y-mitchellkrogza\" title=\"Accessibility\">\ufe0f\ufe0f\ufe0f\ufe0f\u267f\ufe0f</a> <a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Amitchellkrogza\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#blog-mitchellkrogza\" title=\"Blogposts\">\ud83d\udcdd</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=mitchellkrogza\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#content-mitchellkrogza\" title=\"Content\">\ud83d\udd8b</a> <a href=\"#data-mitchellkrogza\" title=\"Data\">\ud83d\udd23</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=mitchellkrogza\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#design-mitchellkrogza\" title=\"Design\">\ud83c\udfa8</a> <a href=\"#example-mitchellkrogza\" title=\"Examples\">\ud83d\udca1</a> <a href=\"#fundingFinding-mitchellkrogza\" title=\"Funding Finding\">\ud83d\udd0d</a> <a href=\"#ideas-mitchellkrogza\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#infra-mitchellkrogza\" title=\"Infrastructure (Hosting, Build-Tools, etc)\">\ud83d\ude87</a> <a href=\"#mentoring-mitchellkrogza\" title=\"Mentoring\">\ud83e\uddd1\u200d\ud83c\udfeb</a> <a href=\"#platform-mitchellkrogza\" title=\"Packaging/porting to new platform\">\ud83d\udce6</a> <a href=\"#plugin-mitchellkrogza\" title=\"Plugin/utility libraries\">\ud83d\udd0c</a> <a href=\"#promotion-mitchellkrogza\" title=\"Promotion\">\ud83d\udce3</a> <a href=\"#question-mitchellkrogza\" title=\"Answering Questions\">\ud83d\udcac</a> <a href=\"https://github.com/funilrys/PyFunceble/pulls?q=is%3Apr+reviewed-by%3Amitchellkrogza\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a> <a href=\"#tool-mitchellkrogza\" title=\"Tools\">\ud83d\udd27</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=mitchellkrogza\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"#tutorial-mitchellkrogza\" title=\"Tutorials\">\u2705</a> <a href=\"#talk-mitchellkrogza\" title=\"Talks\">\ud83d\udce2</a> <a href=\"#userTesting-mitchellkrogza\" title=\"User Testing\">\ud83d\udcd3</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/Nilsonfsilva\"><img src=\"https://avatars.githubusercontent.com/u/91392383?v=4?s=100\" width=\"100px;\" alt=\"Nilsonfsilva\"/><br /><sub><b>Nilsonfsilva</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3ANilsonfsilva\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#infra-Nilsonfsilva\" title=\"Infrastructure (Hosting, Build-Tools, etc)\">\ud83d\ude87</a> <a href=\"#platform-Nilsonfsilva\" title=\"Packaging/porting to new platform\">\ud83d\udce6</a> <a href=\"#tool-Nilsonfsilva\" title=\"Tools\">\ud83d\udd27</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=Nilsonfsilva\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/Odyseus\"><img src=\"https://avatars.githubusercontent.com/u/3822556?v=4?s=100\" width=\"100px;\" alt=\"Odyseus\"/><br /><sub><b>Odyseus</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3AOdyseus\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=Odyseus\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/ybreza\"><img src=\"https://avatars.githubusercontent.com/u/35470865?v=4?s=100\" width=\"100px;\" alt=\"Reza Rizqullah\"/><br /><sub><b>Reza Rizqullah</b></sub></a><br /><a href=\"#design-ybreza\" title=\"Design\">\ud83c\udfa8</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=ybreza\" title=\"Code\">\ud83d\udcbb</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://scripttiger.github.io/\"><img src=\"https://avatars.githubusercontent.com/u/29940916?v=4?s=100\" width=\"100px;\" alt=\"ScriptTiger\"/><br /><sub><b>ScriptTiger</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3AScriptTiger\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#ideas-ScriptTiger\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=ScriptTiger\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/sjhgvr\"><img src=\"https://avatars.githubusercontent.com/u/51121527?v=4?s=100\" width=\"100px;\" alt=\"Stephan van Ruth\"/><br /><sub><b>Stephan van Ruth</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Asjhgvr\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=sjhgvr\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"http://stevenblack.com/\"><img src=\"https://avatars.githubusercontent.com/u/80144?v=4?s=100\" width=\"100px;\" alt=\"Steven Black\"/><br /><sub><b>Steven Black</b></sub></a><br /><a href=\"#ideas-StevenBlack\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#financial-StevenBlack\" title=\"Financial\">\ud83d\udcb5</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/T145\"><img src=\"https://avatars.githubusercontent.com/u/1214129?v=4?s=100\" width=\"100px;\" alt=\"T145\"/><br /><sub><b>T145</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3AT145\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#ideas-T145\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://infosec.exchange/@wally3k\"><img src=\"https://avatars.githubusercontent.com/u/3049142?v=4?s=100\" width=\"100px;\" alt=\"WaLLy3K\"/><br /><sub><b>WaLLy3K</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3AWaLLy3K\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#ideas-WaLLy3K\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/Yuki2718\"><img src=\"https://avatars.githubusercontent.com/u/58900598?v=4?s=100\" width=\"100px;\" alt=\"Yuki2718\"/><br /><sub><b>Yuki2718</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3AYuki2718\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=Yuki2718\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/Zachinquarantine\"><img src=\"https://avatars.githubusercontent.com/u/69423184?v=4?s=100\" width=\"100px;\" alt=\"Zachinquarantine\"/><br /><sub><b>Zachinquarantine</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/commits?author=Zachinquarantine\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"http://bit.ly/cBWeb\"><img src=\"https://avatars.githubusercontent.com/u/28985171?v=4?s=100\" width=\"100px;\" alt=\"ZeroDot1\"/><br /><sub><b>ZeroDot1</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3AZeroDot1\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#ideas-ZeroDot1\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#question-ZeroDot1\" title=\"Answering Questions\">\ud83d\udcac</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=ZeroDot1\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=ZeroDot1\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/avatartw\"><img src=\"https://avatars.githubusercontent.com/u/69660730?v=4?s=100\" width=\"100px;\" alt=\"avatartw\"/><br /><sub><b>avatartw</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Aavatartw\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/dnmTX\"><img src=\"https://avatars.githubusercontent.com/u/34774426?v=4?s=100\" width=\"100px;\" alt=\"dnmTX\"/><br /><sub><b>dnmTX</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3AdnmTX\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#ideas-dnmTX\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#question-dnmTX\" title=\"Answering Questions\">\ud83d\udcac</a> <a href=\"https://github.com/funilrys/PyFunceble/pulls?q=is%3Apr+reviewed-by%3AdnmTX\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a> <a href=\"#data-dnmTX\" title=\"Data\">\ud83d\udd23</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=dnmTX\" title=\"Tests\">\u26a0\ufe0f</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/gwarser\"><img src=\"https://avatars.githubusercontent.com/u/886325?v=4?s=100\" width=\"100px;\" alt=\"gwarser\"/><br /><sub><b>gwarser</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Agwarser\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#data-gwarser\" title=\"Data\">\ud83d\udd23</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=gwarser\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/hawkeye116477\"><img src=\"https://avatars.githubusercontent.com/u/19818572?v=4?s=100\" width=\"100px;\" alt=\"hawkeye116477\"/><br /><sub><b>hawkeye116477</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Ahawkeye116477\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/jawz101\"><img src=\"https://avatars.githubusercontent.com/u/14151703?v=4?s=100\" width=\"100px;\" alt=\"jawz101\"/><br /><sub><b>jawz101</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Ajawz101\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#ideas-jawz101\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#question-jawz101\" title=\"Answering Questions\">\ud83d\udcac</a> <a href=\"#data-jawz101\" title=\"Data\">\ud83d\udd23</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/keczuppp\"><img src=\"https://avatars.githubusercontent.com/u/74409207?v=4?s=100\" width=\"100px;\" alt=\"keczuppp\"/><br /><sub><b>keczuppp</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Akeczuppp\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#ideas-keczuppp\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#question-keczuppp\" title=\"Answering Questions\">\ud83d\udcac</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=keczuppp\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"#data-keczuppp\" title=\"Data\">\ud83d\udd23</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/opav\"><img src=\"https://avatars.githubusercontent.com/u/6770347?v=4?s=100\" width=\"100px;\" alt=\"opav\"/><br /><sub><b>opav</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Aopav\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=opav\" title=\"Tests\">\u26a0\ufe0f</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/rusty-snake\"><img src=\"https://avatars.githubusercontent.com/u/41237666?v=4?s=100\" width=\"100px;\" alt=\"rusty-snake\"/><br /><sub><b>rusty-snake</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Arusty-snake\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=rusty-snake\" title=\"Documentation\">\ud83d\udcd6</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/smed79\"><img src=\"https://avatars.githubusercontent.com/u/1873139?v=4?s=100\" width=\"100px;\" alt=\"smed79\"/><br /><sub><b>smed79</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Asmed79\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#ideas-smed79\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=smed79\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#question-smed79\" title=\"Answering Questions\">\ud83d\udcac</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=smed79\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://speedmann.de/\"><img src=\"https://avatars.githubusercontent.com/u/424659?v=4?s=100\" width=\"100px;\" alt=\"speedmann\"/><br /><sub><b>speedmann</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Aspeedmann\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=speedmann\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://www.mypdns.org/\"><img src=\"https://avatars.githubusercontent.com/u/44526987?v=4?s=100\" width=\"100px;\" alt=\"spirillen\"/><br /><sub><b>spirillen</b></sub></a><br /><a href=\"#a11y-spirillen\" title=\"Accessibility\">\ufe0f\ufe0f\ufe0f\ufe0f\u267f\ufe0f</a> <a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Aspirillen\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=spirillen\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#content-spirillen\" title=\"Content\">\ud83d\udd8b</a> <a href=\"#data-spirillen\" title=\"Data\">\ud83d\udd23</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=spirillen\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#example-spirillen\" title=\"Examples\">\ud83d\udca1</a> <a href=\"#ideas-spirillen\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#maintenance-spirillen\" title=\"Maintenance\">\ud83d\udea7</a> <a href=\"#mentoring-spirillen\" title=\"Mentoring\">\ud83e\uddd1\u200d\ud83c\udfeb</a> <a href=\"#promotion-spirillen\" title=\"Promotion\">\ud83d\udce3</a> <a href=\"#question-spirillen\" title=\"Answering Questions\">\ud83d\udcac</a> <a href=\"https://github.com/funilrys/PyFunceble/pulls?q=is%3Apr+reviewed-by%3Aspirillen\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a> <a href=\"#tool-spirillen\" title=\"Tools\">\ud83d\udd27</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=spirillen\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"#tutorial-spirillen\" title=\"Tutorials\">\u2705</a> <a href=\"#talk-spirillen\" title=\"Talks\">\ud83d\udce2</a> <a href=\"#userTesting-spirillen\" title=\"User Testing\">\ud83d\udcd3</a></td>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/NeolithEra\"><img src=\"https://avatars.githubusercontent.com/u/52778917?v=4?s=100\" width=\"100px;\" alt=\"watchman-pypi\"/><br /><sub><b>watchman-pypi</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3ANeolithEra\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"20%\"><a href=\"https://github.com/xxcriticxx\"><img src=\"https://avatars.githubusercontent.com/u/15007183?v=4?s=100\" width=\"100px;\" alt=\"xxcriticxx\"/><br /><sub><b>xxcriticxx</b></sub></a><br /><a href=\"https://github.com/funilrys/PyFunceble/issues?q=author%3Axxcriticxx\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#ideas-xxcriticxx\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"https://github.com/funilrys/PyFunceble/commits?author=xxcriticxx\" title=\"Tests\">\u26a0\ufe0f</a></td>\n </tr>\n </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\n\n# Special Thanks\n\nThanks to those awesome organization(s), tool(s) and or people(s) for\n\n- Their awesome documentation\n- Their awesome repository\n- Their awesome tool/software/source code\n- Their breaking reports\n- Their contributions\n- Their current work/purpose\n- Their promotion of Py-Funceble\n- Their support\n- Their testings reports\n\nwhich helped and/or still help me build, test and or make\n[PyFunceble](https://github.com/funilrys/PyFunceble) a better tool.\n\n- Adam Warner - [@PromoFaux](https://github.com/PromoFaux)\n- Adblock Plus - [@adblockplus](https://github.com/adblockplus)\n- asciinema - [@asciinema](https://github.com/asciinema)\n- Bob Halley - [@rthalley](https://github.com/rthalley)\n ([DNSPython](https://github.com/rthalley/dnspython))\n- Chris Griffith - [@cdgriffith](https://github.com/cdgriffith)\n ([Box](https://github.com/cdgriffith/Box))\n- Daniel - [@dnmTX](https://github.com/dnmTX)\n- Jonathan Hartley - [@tartley](https://github.com/tartley)\n ([colorama](https://github.com/tartley/colorama))\n- [IANA](https://www.iana.org/) - [ICANN](https://www.icann.org/)\n ([Root Zone Database](https://www.iana.org/domains/root/db))\n- [Iterative](https://github.com/iterative)\n ([shtab](https://github.com/iterative/shtab))\n- Kenneth Reitz - [@kennethreitz](https://github.com/kennethreitz)\n ([requests](https://github.com/kennethreitz/requests))\n- Mitchell Krog - [@mitchellkrogza](https://github.com/mitchellkrogza)\n- Mohammad Fares - [@faressoft](https://github.com/faressoft)\n ([Terminalizer](https://github.com/faressoft/terminalizer))\n- Pi-Hole - [@pi-hole](https://github.com/pi-hole/pi-hole)\n- Public Suffix List -\n [@publicsuffix](https://github.com/publicsuffix)\n- Reza Rizqullah - [@ybreza](https://github.com/ybreza)\n- Saurabh Kumar - [@theskumar](https://github.com/theskumar)\n ([python-dotenv](https://github.com/theskumar/python-dotenv))\n- ScriptTiger - [@ScriptTiger](https://github.com/ScriptTiger)\n- SMed79 - [@SMed79](https://github.com/SMed79)\n- spirillen - [@spirillen](https://www.mypdns.org/p/Spirillen/)\n- The YAML Project - [@yaml](https://github.com/yaml)\n ([pyyaml](https://github.com/yaml/pyyaml))\n- [yWorks](https://www.yworks.com) - ([yEd Graph\n Editor](https://www.yworks.com/products/yed))\n\n# License\n\n Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 Nissar Chababy\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n https://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "The tool to check the availability or syntax of domain, IP or URL.",
"version": "4.2.29",
"project_urls": {
"Documentation": "https://docs.pyfunceble.com",
"Funding": "https://github.com/sponsors/funilrys",
"Homepage": "https://github.com/funilrys/PyFunceble",
"Source": "https://github.com/funilrys/PyFunceble/tree/dev",
"Tracker": "https://github.com/funilrys/PyFunceble/issues"
},
"split_keywords": [
"pyfunceble",
" syntax-checker",
" reputation-checker",
" availability-checker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b29ebdcec26a66e44ae6920b346cbbb3ec8580752edb994835dd6d13a4a0f61b",
"md5": "8026f72f3b8c31c0f96d7fc550852d04",
"sha256": "cc0c091dab5c63e124767e2508dcd543376c3138b058430d908725f5ab645940"
},
"downloads": -1,
"filename": "PyFunceble_dev-4.2.29-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8026f72f3b8c31c0f96d7fc550852d04",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 517420,
"upload_time": "2024-09-24T20:51:08",
"upload_time_iso_8601": "2024-09-24T20:51:08.741707Z",
"url": "https://files.pythonhosted.org/packages/b2/9e/bdcec26a66e44ae6920b346cbbb3ec8580752edb994835dd6d13a4a0f61b/PyFunceble_dev-4.2.29-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6f474206eed817dea73485644c5541ad3d971c823cbf5f67dd50b3e61c713558",
"md5": "d8d0715eeed779dc2686c8475447e58a",
"sha256": "64aec9f21800a98633dac3d9404cc01bb8d4848cd0e23e81c73357f0215c93f7"
},
"downloads": -1,
"filename": "pyfunceble_dev-4.2.29.tar.gz",
"has_sig": false,
"md5_digest": "d8d0715eeed779dc2686c8475447e58a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 251969,
"upload_time": "2024-09-24T20:51:11",
"upload_time_iso_8601": "2024-09-24T20:51:11.555281Z",
"url": "https://files.pythonhosted.org/packages/6f/47/4206eed817dea73485644c5541ad3d971c823cbf5f67dd50b3e61c713558/pyfunceble_dev-4.2.29.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-24 20:51:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "funilrys",
"github_project": "PyFunceble",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "pyfunceble-dev"
}