Skip to main content

Python API for interacting with *hole.

Project description

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 is consuming the details provided by the endpoint api.php only for now.

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.

Installation

The module is available from the Python Package Index.

$ pip3 install hole

On a Fedora-based system.

$ sudo dnf -y install python-hole

For Nix or NixOS is a pre-packed module available. The lastest release is usually present in the unstable channel.

$ nix-env -iA nixos.python3Packages.hole

Usage

The file example.py contains an example about how to use this module.

Roadmap

There are more features on the roadmap but there is no ETA because I prefer to support Open Source projects were third party contributions are appreciated.

License

python-hole is licensed under MIT, for more details check LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hole-0.8.0.tar.gz (5.3 kB view details)

Uploaded Source

File details

Details for the file hole-0.8.0.tar.gz.

File metadata

  • Download URL: hole-0.8.0.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0

File hashes

Hashes for hole-0.8.0.tar.gz
Algorithm Hash digest
SHA256 ce48212c97b54b3376a8e78bdb7f93d884a31a4b8e0ddf6d240d6d3b7870d9ad
MD5 f7598cfb08f91e3124be355d758775cc
BLAKE2b-256 458b6ae8e2083eb52baa81b1c11daa5ca2652f7d0e7942edae488ab9c1e0c170

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page