You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/update/dev.rst
+41-24Lines changed: 41 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,36 @@
1
1
Development version
2
2
-------------------
3
3
4
-
IMPORTANT INFORMATION for :code:`dev >= 3.2.11`
4
+
Important information for :code:`dev >= 3.2.11`
5
5
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6
6
7
-
.. warning::
7
+
When you update from dev@<=3.2.10 or master@<=3.2.2 to newer release, there
8
+
will be made a SQL conversion of the databases table layout.
9
+
This can take up a sagnificent amount of time based on the size of the
10
+
database.
8
11
9
-
::
12
+
The table layout converion is being made to:
13
+
14
+
1. Minimize the total size
10
15
11
-
When you update from dev@<=3.2.10 or master@<=3.2.2
12
-
to newer release, there will be made a SQL
13
-
conversion of the databases table layout.
14
-
This can take up a sagnificent amount of time
15
-
based on the size of the Database.
16
+
2. Optimize the sql flow and minimizing the read/write to save disk I/O.
16
17
17
-
The table layout converion is being made to:
18
+
3. Minimize the number of SQL queries being made
18
19
19
-
1. Minimize the total size
20
+
It have been seen taking days to convert these tables on very large
21
+
installations.
20
22
21
-
2. Optimize the sql flow and minimizing the
22
-
read/write to save disk I/O
23
23
24
-
3. Minimize the number of SQL queries being made
24
+
Important information for :code:`dev >= 4.0.0`
25
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
25
26
26
-
It have been seen taking days to convert these
27
-
tables on very large installations.
27
+
When you update to PyFunceble :code:`4.0.0`, there will be
28
+
29
+
- a SQL conversion if you use the :code:`mysql` or `mariadb` database type.
30
+
- a JSON to CSV conversion if one of those files is found in your filesystem:
31
+
32
+
- :code:`inactive_db.json`
33
+
- :code:`whois_db.json`
28
34
29
35
30
36
For development
@@ -58,9 +64,13 @@ From PyPi
58
64
$ pip3 install --user --upgrade PyFunceble-dev
59
65
60
66
.. note::
61
-
We recommend the :code:`--user` flag which installs the required dependencies at the user level. More information about it can be found on `pip documentation`_.
67
+
We recommend the :code:`--user` flag which installs the required dependencies
68
+
at the user level. More information about it can be found on
69
+
`pip documentation`_.
70
+
62
71
.. warning::
63
-
We do not recommend the :code:`--user` flag when using :code:`PyFunceble` into containers like - for example - Travis CI.
72
+
We do not recommend the :code:`--user` flag when using :code:`PyFunceble`
We recommend the :code:`--user` flag which installs the required dependencies at the user level. More information about it can be found on `pip documentation`_.
83
+
We recommend the :code:`--user` flag which installs the required dependencies
84
+
at the user level. More information about it can be found on
85
+
`pip documentation`_.
74
86
.. warning::
75
-
We do not recommend the :code:`--user` flag when using :code:`PyFunceble` into containers like - for example - Travis CI.
87
+
We do not recommend the :code:`--user` flag when using :code:`PyFunceble`
88
+
into containers like - for example - Travis CI.
76
89
77
90
Using the AUR (for Arch Linux users)
78
91
""""""""""""""""""""""""""""""""""""
@@ -90,8 +103,10 @@ With your favorite AUR helper
90
103
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
91
104
92
105
.. warning::
93
-
We do not recommend any AUR helper but keep in mind that some AUR helpers are "better" than other.
94
-
For more information about your current (or any other) AUR helper please report to `the ArchWiki page`_.
106
+
We do not recommend any AUR helper but keep in mind that some AUR helpers
107
+
are "better" than other.
108
+
For more information about your current (or any other) AUR helper please
109
+
report to `the ArchWiki page`_.
95
110
96
111
::
97
112
@@ -126,12 +141,14 @@ Execute the following and enjoy PyFunceble!
126
141
$ git fetch origin && git merge origin/dev
127
142
$ python3 setup.py test
128
143
$ python3 setup.py install # Avoid this if you want to uninstall one day.
We recommend the :code:`--user` flag which installs the required dependencies at the user level. More information about it can be found on `pip documentation`_.
147
+
We recommend the :code:`--user` flag which installs the required dependencies
148
+
at the user level. More information about it can be found on `pip documentation`_.
133
149
.. warning::
134
-
We do not recommend the :code:`--user` flag when using :code:`PyFunceble` into containers like - for example - Travis CI.
150
+
We do not recommend the :code:`--user` flag when using :code:`PyFunceble`
Copy file name to clipboardExpand all lines: docs/update/stable.rst
+48-28Lines changed: 48 additions & 28 deletions
Original file line number
Diff line number
Diff line change
@@ -1,33 +1,38 @@
1
1
Stable version
2
2
--------------
3
3
4
-
Using :code:`pip`
5
-
^^^^^^^^^^^^^^^^^
4
+
Important information for :code:`dev >= 3.2.11`
5
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6
6
7
-
IMPORTANT INFORMATION for :code:`master >= 3.3.0`
8
-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7
+
When you update from dev@<=3.2.10 or master@<=3.2.2 to newer release, there
8
+
will be made a SQL conversion of the databases table layout.
9
+
This can take up a sagnificent amount of time based on the size of the
10
+
database.
9
11
10
-
.. warning::
12
+
The table layout converion is being made to:
11
13
12
-
::
14
+
1. Minimize the total size
15
+
16
+
2. Optimize the sql flow and minimizing the read/write to save disk I/O.
17
+
18
+
3. Minimize the number of SQL queries being made
13
19
14
-
When you update from version before 3.3.0
15
-
to newer release, there will be made a SQL
16
-
conversion of the databases table layout.
17
-
This can take up a sagnificent amount of time
18
-
based on the size of the Database.
20
+
It have been seen taking days to convert these tables on very large
21
+
installations.
19
22
20
-
The table layout converion is being made to:
23
+
Important information for :code:`dev >= 4.0.0`
24
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
21
25
22
-
1. Minimize the total size
26
+
When you update to PyFunceble :code:`4.0.0`, there will be
23
27
24
-
2. Optimize the sql flow and minimizing the
25
-
read/write to save disk I/O
28
+
- a SQL conversion if you use the :code:`mysql` or `mariadb` database type.
29
+
- a JSON to CSV conversion if one of those files is found in your filesystem:
26
30
27
-
3. Minimize the number of SQL queries being made
31
+
- :code:`inactive_db.json`
32
+
- :code:`whois_db.json`
28
33
29
-
It have been seen taking days to convert these
30
-
tables on very large installations.
34
+
Using :code:`pip`
35
+
^^^^^^^^^^^^^^^^^
31
36
32
37
From PyPi
33
38
"""""""""
@@ -37,9 +42,13 @@ From PyPi
37
42
$ pip3 install --user --upgrade PyFunceble
38
43
39
44
.. note::
40
-
We recommend the :code:`--user` flag which installs the required dependencies at the user level. More information about it can be found on `pip documentation`_.
45
+
We recommend the :code:`--user` flag which installs the required dependencies
46
+
at the user level. More information about it can be found on
47
+
`pip documentation`_.
48
+
41
49
.. warning::
42
-
We do not recommend the :code:`--user` flag when using :code:`PyFunceble` into containers like - for example - Travis CI.
50
+
We do not recommend the :code:`--user` flag when using :code:`PyFunceble`
We recommend the :code:`--user` flag which installs the required dependencies at the user level. More information about it can be found on `pip documentation`_.
61
+
We recommend the :code:`--user` flag which installs the required dependencies
62
+
at the user level. More information about it can be found on
63
+
`pip documentation`_.
64
+
53
65
.. warning::
54
-
We do not recommend the :code:`--user` flag when using :code:`PyFunceble` into containers like - for example - Travis CI.
66
+
We do not recommend the :code:`--user` flag when using :code:`PyFunceble`
67
+
into containers or CI engines.
55
68
56
69
Using the AUR (for Arch Linux users)
57
70
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -69,12 +82,14 @@ With your favorite AUR helper
69
82
"""""""""""""""""""""""""""""
70
83
71
84
.. warning::
72
-
We do not recommend any AUR helper but keep in mind that some AUR helpers are "better" than other.
73
-
For more information about your current (or any other) AUR helper please report to `the ArchWiki page`_.
85
+
We do not recommend any AUR helper but keep in mind that some AUR helpers
86
+
are "better" than other.
87
+
For more information about your current (or any other) AUR helper please
88
+
report to `the ArchWiki page`_.
74
89
75
90
::
76
91
77
-
$ yourFavoriteAurHelper -Syu python-pyfunceble
92
+
$ yourFavoriteAurHelper -Syu python-pyfunceble
78
93
79
94
Using docker (hub)
80
95
^^^^^^^^^^^^^^^^^^
@@ -106,12 +121,17 @@ Execute the following and enjoy PyFunceble!
We recommend the :code:`--user` flag which installs the required dependencies at the user level. More information about it can be found on `pip documentation`_.
127
+
We recommend the :code:`--user` flag which installs the required dependencies
128
+
at the user level. More information about it can be found on
129
+
`pip documentation`_.
130
+
131
+
113
132
.. warning::
114
-
We do not recommend the :code:`--user` flag when using :code:`PyFunceble` into containers like - for example - Travis CI.
133
+
We do not recommend the :code:`--user` flag when using :code:`PyFunceble`
0 commit comments