Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/funilrys/PyFunceble

The tool to check the availability or syntax of domain, IP or URL.
https://github.com/funilrys/PyFunceble
availability availability-checker availability-monitor domain domain-access domain-controller domain-name domains hosts hosts-file http-status-code network nslookup pyfunceble testing testing-tool testing-tools url url-monitor whois
Last synced: about 2 months ago
JSON representation
The tool to check the availability or syntax of domain, IP or URL.
Host: GitHub
URL: https://github.com/funilrys/PyFunceble
Owner: funilrys
License: apache-2.0
Created: 2017-10-15T08:25:14.000Z (about 7 years ago)
Default Branch: dev
Last Pushed: 2024-10-27T01:12:18.000Z (about 2 months ago)
Last Synced: 2024-10-28T02:18:34.626Z (about 2 months ago)
Topics: availability, availability-checker, availability-monitor, domain, domain-access, domain-controller, domain-name, domains, hosts, hosts-file, http-status-code, network, nslookup, pyfunceble, testing, testing-tool, testing-tools, url, url-monitor, whois
Language: Python
Homepage: https://pyfunceble.github.io
Size: 8.85 MB
Stars: 299
Watchers: 15
Forks: 45
Open Issues: 26
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Support: docs/support.md
Awesome Lists containing this project

README

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

- [Installation](#installation)

  - [Packages \& Versioning](#packages--versioning)

  - [PyPi - Python Package Index](#pypi---python-package-index)

    - [Optional Dependencies](#optional-dependencies)

    - [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 |

### 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:

```shell

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

```

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

```shell

pip3 install --user pyfunceble[docs,test]

```

### 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 .[docs]

# 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.

  

    

      
_{Avinash Reddy}
🐛

      
_BigDargon
🐛 🤔 💬 👀 🔣 ⚠️

      
_Fanboynz
🐛 🤔 💵 ⚠️ 📓

      
_{Haris Gušić}
📖 ️️️️♿️ 🔧 ⚠️ 📹 ✅ 💻

      
_{Imre Eilertsen}
️️️️♿️ 🐛 🔣 💡 💵 🤔 📣 💬 👀 🔧 ⚠️ 📓

    

    

      
_{Kowith Singkornkeeree}
🐛

      
_{Mitchell Krog}
️️️️♿️ 🐛 📝 💻 🖋 🔣 📖 🎨 💡 🔍 🤔 🚇 🧑‍🏫 📦 🔌 📣 💬 👀 🔧 ⚠️ ✅ 📢 📓

      
_Nilsonfsilva
🐛 🚇 📦 🔧 ⚠️

      
_Odyseus
🐛 ⚠️

      
_{Reza Rizqullah}
🎨 💻

    

    

      
_{Samuel Bishop}
🐛 🤔

      
_ScriptTiger
🐛 🤔 ⚠️

      
_{Stephan van Ruth}
🐛 ⚠️

      
_{Steven Black}
🤔 💵

      
_T145
🐛 🤔

    

    

      
_WaLLy3K
🐛 🤔

      
_Yuki2718
🐛 ⚠️

      
_{Zachinquarantine}
💻

      
_ZeroDot1
🐛 🤔 💬 ⚠️ 💻

      
_avatartw
🐛

    

    

      
_dnmTX
🐛 🤔 💬 👀 🔣 ⚠️

      
_gwarser
🐛 🔣 ⚠️

      
_{hawkeye116477}
🐛

      
_jawz101
🐛 🤔 💬 🔣

      
_keczuppp
🐛 🤔 💬 ⚠️ 🔣

    

    

      
_opav
🐛 ⚠️

      
_rusty-snake
🐛 📖

      
_smed79
🐛 🤔 💻 💬 ⚠️

      
_speedmann
🐛 ⚠️

      
_spirillen
️️️️♿️ 🐛 💻 🖋 🔣 📖 💡 🤔 🚧 🧑‍🏫 📣 💬 👀 🔧 ⚠️ ✅ 📢 📓

    

    

      
_{watchman-pypi}
🐛

      
_xxcriticxx
🐛 🤔 ⚠️

    

  

# 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.