ewpratten / pihole-api

A python3 wrapper for the pihole api that aims to eventually be a full replacement for the AdminLTE web panel
https://pypi.org/project/PiHole-api/
MIT License
50 stars 11 forks source link

Error in documentation about how to add a Regular Expression on the Blacklist #12

Open mdeterink opened 3 years ago

mdeterink commented 3 years ago

Dear Ewpratten,

I found an error in your documentation. The bottom line says:

The example blacklists google.com. Replacing black with one of: white, black, wild, regex, or audit will change the list to be added to. To remove a domain form a list, replace add() with sub()

This is not correct. If you would like to add a domain as a wild card, then thy Python entry should be:

pihole.add("regex_black", "(\.|^)google\.com$")

Actually adding an underscore between regex and black. Please add this to the documentation. Thanks!

ewpratten commented 3 years ago

This has changed since the library was written. Ill look into it