|
4 | 4 | > Soon there will be two Python packages for accessing Cloudflare's API. |
5 | 5 | > |
6 | 6 | > 1. This original [package](https://github.com/cloudflare/python-cloudflare), which was initially introduced [here](https://blog.cloudflare.com/python-cloudflare/). |
7 | | -> 2. A ground-up rewrite of the SDK, released under `3.x`, at some point in the future. See [here](https://github.com/cloudflare/python-cloudflare/discussions/191) |
| 7 | +> 2. A ground-up rewrite of the SDK, released under `3.*`, at some point in the future. See [here](https://github.com/cloudflare/python-cloudflare/discussions/191) |
8 | 8 | > |
9 | | -> If you like using this package in it's present form, it is highly recommended that you pin to the `2.x` releases now. |
| 9 | +> If you like using this package in it's present form, it is highly recommended that you pin to the `2.*` releases now. |
10 | 10 | > |
11 | 11 | > ```bash |
12 | 12 | > $ cat ${YOUR_PROJECT}/requirements.txt |
|
18 | 18 | > ```bash |
19 | 19 | > $ pip install --upgrade cloudflare==2.19.* |
20 | 20 | > ... |
21 | | -> Successfully installed cloudflare-2.19.3 |
| 21 | +> Successfully installed cloudflare-2.19.4 |
22 | 22 | > $ |
23 | 23 |
|
24 | 24 | > [!WARNING] |
25 | | -> Release `3.x` will not be code-compatible/call-compatible with previous releases (i.e. release `1.x` and `2.x`). |
| 25 | +> Release `2.20.*` is now available and it will produce a warning message explaining all this via stderr (the standard error output). |
| 26 | +> This messages does not stop the program from operating, it's just a warning. |
| 27 | +> If you wish to surpress this message (which is a bad idea because pinning to `2.19.*` is the right thing to do), then do the following in your code: |
| 28 | +> ```python |
| 29 | +> cf = CloudFlare.CloudFlare(..., warnings=False) |
| 30 | +> ``` |
| 31 | +> Or, if you use `cli4`, then the following. |
| 32 | +> ```bash |
| 33 | +> $ cli4 -w False ... |
| 34 | +>``` |
| 35 | +
|
| 36 | +> [!WARNING] |
| 37 | +> Release `3.*` will not be code-compatible/call-compatible with previous releases (i.e. release `1.*` and `2.*`). |
26 | 38 |
|
27 | | -When you see this README complete change you will know that `3.x` has been released; however, until then, this code will be released under a `2.19.x` release number. |
| 39 | +When you see this README complete change you will know that `3.*` has been released; however, until then, this code will be released under a `2.19.*` release number. |
28 | 40 |
|
29 | 41 | ## Package stats |
30 | 42 |
|
|
0 commit comments