Python API for interacting with a xyz-hole instance. You know the thing that is blocking Ads by manipulating your DNS requests and run on your single board computer or on other hardware with different operating systems.
This module supports both v5 and v6 versions of the API through a unified interface. Simply specify the version when creating your client:
.. code:: python
from hole import Hole
# For v6 (default)
client = Hole("YOUR_API_TOKEN")
# For v5
client_v5 = Hole("YOUR_API_TOKEN", version=5)
This module is consuming the details provided by the endpoint api.php and other
API endpoints available in v5 and v6.
If you wonder why the weird name and that the usage of xzy-hole instead of the real name, please contact the trademark holder. They were unhappy with original name of the module and came up with very funny ideas which were not feasible or match the existing naming standards. Also, it should remind us that a community is a vital part of every Open Source project.
This module is not supported or endorsed by that particular trademark holder. The development happens independently, they are not providing resources and the module may no longer work if they breaking their API endpoint.
The module is available from the Python Package Index <https://pypi.python.org/pypi>_.
.. code:: bash
$ pip3 install hole
On a Fedora-based system.
.. code:: bash
$ sudo dnf -y install python-hole
For Nix or NixOS is a pre-packed module <https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&query=hole>_
available. The lastest release is usually present in the unstable channel.
.. code:: bash
$ nix-env -iA nixos.python3Packages.hole
The files examplev5.py and examplev6.py contains examples about how to use this module.
There are more features on the roadmap but there is no ETA because I prefer to support Open Source projects where third party contributions are appreciated.
python-hole is licensed under MIT, for more details check LICENSE.
FAQs
Python API for interacting with *hole.
We found that hole demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Browserslist-rs now uses static data to reduce binary size by over 1MB, improving memory use and performance for Rust-based frontend tools.
Research
Security News
Eight new malicious Firefox extensions impersonate games, steal OAuth tokens, hijack sessions, and exploit browser permissions to spy on users.
Security News
The official Go SDK for the Model Context Protocol is in development, with a stable, production-ready release expected by August 2025.