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 holeOn a Fedora-based system.
$ sudo dnf -y install python-holeFor Nix or NixOS is pre-packed module available. The lastest release is usually present in the unstable channel.
$ nix-env -iA nixos.python3Packages.holeUsage
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.
Development
For development is recommended to use a venv.
$ python3 -m venv .
$ source bin/activate
$ python3 setup.py developLicense
python-hole is licensed under MIT, for more details check LICENSE.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file hole-0.6.0.tar.gz.
File metadata
- Download URL: hole-0.6.0.tar.gz
- Upload date:
- Size: 5.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4fa53a595c7ee7efd46924b698c9a30235aeebbbadf981a9ab6a283fd6046b32 |
|
| MD5 | b6e23ed3b8139ed65aaf73a4c0602fb9 |
|
| BLAKE2b-256 | 4d88f3ba9260775462fc1468cd0ddc69ba5c828719d5be38fcf7bc3c4a195aaf |
File details
Details for the file hole-0.6.0-py3-none-any.whl.
File metadata
- Download URL: hole-0.6.0-py3-none-any.whl
- Upload date:
- Size: 4.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7b0e67884a2eb600005e5ba1b8bb593dcfd1e4743fe3d6ec7f1a0b2084983241 |
|
| MD5 | e3e9e9cb088d069fba41b0c887d89c8a |
|
| BLAKE2b-256 | 7957ea87c8c162bbecbb0182ed1688cd4baea6b7815be0d2f3a04f61d7da37c2 |
