blocker is a Python package to check if a indicator is in a blocklist.
There are two main data definitions at this time that drive the blocker package. These defined the different locations to check against.
- Retrieve blocklist data from multiple sources
- Check if a IP address is on a DNSBL (DNS Block List)
- Collects data using multi-threading
You can install blocker via pip from PyPI:
$ pip install blockerIf you are using poetry (recommended) you can add it to your package using
poetry add blockerBelow is the command line reference but you can also use the current version of blocker to retrieve the help by typing blocker --help.
NAME
blocker - Lookup is the main method to check if a given value can be identified in block lists.
SYNOPSIS
blocker VALUE <flags>
DESCRIPTION
The consumer of this method can toggle the different checks as needed.
POSITIONAL ARGUMENTS
VALUE
Type: str
A value to lookup. This is typically going to be a domain, ip address, etc.
FLAGS
-t, --text_list=TEXT_LIST
Type: bool
Default: False
Whether or not to check text based lists. Defaults to False.
-d, --dns_list=DNS_LIST
Type: bool
Default: False
Whether or not to check dns lists. Defaults to False.
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTSContributions are very welcome. To learn more, see the Contributor Guide.
You can clone the repositry and begin development using
git clone https://github.com/MSAdministrator/blocker.git
cd blocker
poetry installIf you are using pyenv to manage your enviroments you can set a config option in poetry to use the set pyenv version of python by running this:
poetry config virtualenvs.create true
poetry installDistributed under the terms of the [MIT license] 6798 [LICENSE.md], blocker is free and open source software.
Security concerns are a top priority for us, please review our Security Policy.
If you encounter any problems, please file an issue along with a detailed description.
This project was generated from @MSAdministrator's Hypermodern Python Cookiecutter template.