Add warnings for breaking changes

[CosmicHorrorDev]

To make sure library users are aware I'm planning on adding warnings for #9 and #10 first, and then actually releasing the breaking change under 3.0.0 six months after the warnings are added. This should give some time to prepare for any changes, while library users can switch back down the minor release to avoid the warnings after they see them.

Hello Users

You may be seeing this because the deprecation warning linked you here. As you've seen there will be breaking changes to the public API which may end up breaking your code as well. For that reason I've added deprecation warnings to the breaking changes and am planning on switching on the next major release (v3.0.0) which I plan on publishing on 2021-06-01.

This matters to you only if you either use the premium API (with an API key) since one of the changes affects the precedence of passing in the key as a param vs and env variable (#10), or you handle specific errors raised by the API (#9). If you don't handle errors, then you likely should since you could very well at least exhaust the daily proxy allowance.

Your options currently are

• Switch to the breaking changes early by using the master branch (directions below).
• Never update to the breaking changes. If this fits you then simply sticking to v2.0.0 will get rid of the annoying deprecation warnings and not switch to breaking changes. This of course implicitly means that there likely won't be receiving any further updates including other possible bug fixes.

Updating to the master branch

pip

Installing with this command should do the trick (as usual you should probably use virtual environments).

pip install https://github.com/LovecraftianHorror/pubproxpy/archive/master.zip

poetry

Simply using this for your dependency should work

pubproxpy = { git = "https://github.com/LovecraftianHorror/pubproxpy" }