Installation

Requirements

Here is the list of requirements:

  • Python 3.6+
  • colorama
  • domain2idna
  • PyYAML
  • requests
  • setuptools
  • urllib3

Python 3.6+

As we use for example

print('hello', end=' ')

which does not exist in Python 2.x and as I wanted to give a priority to Python 3, Python 3 is required.

colorama

As we use some coloration coloration, colorama is required.

domain2idna

As we propose the conversion of domains to IDNA, domain2idna is required.

Note

domain2idna is maintained and developed by Nissar Chababy (@funilrys), the main developer of PyFunceble. Its source code can be found on GitHub.

PyYAML

As our configuration file is written in .yaml, PyYAML is required.

requests

As we use requests when calling all Lookup() methods, requests is required.

setuptools

As we use install_requires=xx inside our setup.py, setuptools is required.

urllib3

You should normally already have it. But as we handle some of its errors while using requests, urllib3 is required.

Get PyFunceble

Stable version

Using pip

Choose your repository, install and enjoy PyFunceble!

From PyPi
$ pip3 install PyFunceble
From GitHub
$ pip3 install git+https://github.com/funilrys/PyFunceble.git@master#egg=PyFunceble

Using the AUR (for Arch Linux users)

The package can be found at https://aur.archlinux.org/packages/python-pyfunceble/.

With makepkg
$ wget https://aur.archlinux.org/cgit/aur.git/plain/PKGBUILD?h=python-pyfunceble
$ makepkg
$ sudo pacman -U python-pyfunceble*.tar.xz
With your favorite AUR helper

Warning

We do not recommend any AUR helper but keep in mind that some AUR helpers are “better” than other. For more information about your current (or any other) AUR helper please report to the ArchWiki page.

$ yourFavoriteAurHelper -S python-pyfunceble

Pure Python method

Execute the following and enjoy PyFunceble!

$ git clone https://github.com/funilrys/PyFunceble.git
$ cd PyFunceble
$ python3 setup.py test && python3 setup.py install

Development version

The development version of PyFunceble represents the dev branch. It’s intended for the development of next features but is always at a usable state.

Indeed, We should not push to the dev branch until we are sure that the new commit does not break or introduce critical issue under PyFunceble.

For development

Execute the following and let’s hack PyFunceble!

Note

We highly recommend you to develop PyFunceble under a virtualenv.

$ git clone https://github.com/funilrys/PyFunceble.git
$ cd PyFunceble && git checkout dev && virtualenv venv
$ source venv/bin/activate && pip3 install -e .

Note

After installing with:

$ source venv/bin/activate && pip3 install -e .
  • you only need to update the repository.
  • you don’t have to rerun the pip command.

For usage

Using pip

Execute one of the following and enjoy PyFunceble!

From PyPi

$ pip3 install PyFunceble-dev

From GitHub

$ pip3 install git+https://github.com/funilrys/PyFunceble.git@dev#egg=PyFunceble
Using the AUR (for Arch Linux users)

The package can be found at https://aur.archlinux.org/packages/python-pyfunceble-dev/.

With makepkg

$ wget https://aur.archlinux.org/cgit/aur.git/plain/PKGBUILD?h=python-pyfunceble-dev
$ makepkg
$ sudo pacman -U python-pyfunceble-dev*.tar.xz

With your favorite AUR helper

Warning

We do not recommend any AUR helper but keep in mind that some AUR helpers are “better” than other. For more information about your current (or any other) AUR helper please report to the ArchWiki page.

$ yourFavoriteAurHelper -S python-pyfunceble-dev
Pure Python method

Execute the following and enjoy PyFunceble!

$ git clone https://github.com/funilrys/PyFunceble.git
$ cd PyFunceble && git checkout dev
$ python3 setup.py test && python3 setup.py install

First steps

Make sure that you can run

$ PyFunceble --version

and enjoy PyFunceble!!