Update¶
Stable version¶
Important information for dev >= 3.2.11
¶
When you update from dev@<=3.2.10 or master@<=3.2.2 to newer release, there will be made a SQL conversion of the databases table layout. This can take up a sagnificent amount of time based on the size of the database.
The table layout converion is being made to:
- Minimize the total size
- Optimize the sql flow and minimizing the read/write to save disk I/O.
- Minimize the number of SQL queries being made
It have been seen taking days to convert these tables on very large installations.
Important information for dev >= 4.0.0
¶
When you update to PyFunceble 4.0.0
, there will be
a SQL conversion if you use the
mysql
or mariadb database type.a JSON to CSV conversion if one of those files is found in your filesystem:
inactive_db.json
whois_db.json
a breaking and compatibility issue if you try to directly (automatically ?) read the data in the output directory. Indeed if you were looking for
output/domains/ACTIVE/list
in PyFunceble3.x
, in4.0
, it is now underoutput/{{ input_file_name }}/domains/ACTIVE list
.
Using pip
¶
From PyPi¶
$ pip3 install --user --upgrade PyFunceble
Note
We recommend the --user
flag which installs the required dependencies
at the user level. More information about it can be found on
pip documentation.
Warning
We do not recommend the --user
flag when using PyFunceble
into containers or CI engines.
From GitHub¶
$ pip3 install --user --upgrade git+https://github.com/funilrys/PyFunceble.git@master#egg=PyFunceble
Note
We recommend the --user
flag which installs the required dependencies
at the user level. More information about it can be found on
pip documentation.
Warning
We do not recommend the --user
flag when using PyFunceble
into containers or CI engines.
Using the AUR (for Arch Linux users)¶
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 -Syu python-pyfunceble
Using docker (hub)¶
The image description can be found at https://hub.docker.com/r/pyfunceble/pyfunceble
$ docker pull pyfunceble/pyfunceble
Using conda
¶
Our repository is located at https://anaconda.org/pyfunceble/pyfunceble
conda update -c conda-forge -c pyfunceble pyfunceble
Pure Python method¶
Execute the following and enjoy PyFunceble!
$ cd PyFunceble
$ git checkout master && git fetch origin && git merge origin/master
$ python3 setup.py test
$ python3 setup.py install # Avoid this if you want to uninstall one day.
$ pip3 install --user --upgrade -e . # Prefer this method.
Note
We recommend the --user
flag which installs the required dependencies
at the user level. More information about it can be found on
pip documentation.
Warning
We do not recommend the --user
flag when using PyFunceble
into containers like - for example - Travis CI.
Development version¶
Important information for dev >= 3.2.11
¶
When you update from dev@<=3.2.10 or master@<=3.2.2 to newer release, there will be made a SQL conversion of the databases table layout. This can take up a sagnificent amount of time based on the size of the database.
The table layout converion is being made to:
- Minimize the total size
- Optimize the sql flow and minimizing the read/write to save disk I/O.
- Minimize the number of SQL queries being made
It have been seen taking days to convert these tables on very large installations.
Important information for dev >= 4.0.0
¶
When you update to PyFunceble 4.0.0
, there will be
a SQL conversion if you use the
mysql
or mariadb database type.a JSON to CSV conversion if one of those files is found in your filesystem:
inactive_db.json
whois_db.json
a breaking and compatibility issue if you try to directly (automatically ?) read the data in the output directory. Indeed if you were looking for
output/domains/ACTIVE/list
in PyFunceble3.x
, in4.0
, it is now underoutput/{{ input_file_name }}/domains/ACTIVE list
.
For development¶
$ cd PyFunceble && git checkout dev
$ git fetch origin && git merge origin/dev
Note
As you previously installed with
$ . venv/bin/activate && pip3 install -e .
Only code/repository update is required.
For usage¶
Using pip
¶
From PyPi¶
$ pip3 install --user --upgrade PyFunceble-dev
Note
We recommend the --user
flag which installs the required dependencies
at the user level. More information about it can be found on
pip documentation.
Warning
We do not recommend the --user
flag when using PyFunceble
into containers like - for example - Travis CI.
From GitHub¶
$ pip3 install --user --upgrade git+https://github.com/funilrys/PyFunceble.git@dev#egg=PyFunceble
Note
We recommend the --user
flag which installs the required dependencies
at the user level. More information about it can be found on
pip documentation.
Warning
We do not recommend the --user
flag when using PyFunceble
into containers like - for example - Travis CI.
Using the AUR (for Arch Linux users)¶
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 -Syu python-pyfunceble-dev
Using docker (hub)¶
The image description can be found at https://hub.docker.com/r/pyfunceble/pyfunceble-dev
$ docker pull pyfunceble/pyfunceble-dev
Using conda
¶
Our repository is located at https://anaconda.org/pyfunceble/pyfunceble-dev
conda update -c conda-forge -c pyfunceble pyfunceble-dev
Pure Python method¶
Execute the following and enjoy PyFunceble!
$ cd PyFunceble && git checkout dev
$ git fetch origin && git merge origin/dev
$ python3 setup.py test
$ python3 setup.py install # Avoid this if you want to uninstall one day.
$ pip3 install --user --upgrade -e . # Prefer this method.
Note
We recommend the --user
flag which installs the required dependencies
at the user level. More information about it can be found on pip documentation.
Warning
We do not recommend the --user
flag when using PyFunceble
into containers or CI engines.