Tools for interacting with the Checkmate URL checking service.
Project description
checkmatelib
Tools for interacting with the Checkmate URL checking service.
Usage
from checkmatelib import CheckmateClient, CheckmateException
client = CheckmateClient("http://checkmate.example.com")
try:
hits = client.check_url("http://bad.example.com", "YOUR_CHECKMATE_API_KEY")
except CheckmateException:
... # To block or not to block?
if hits:
print(hits.reason_codes)
Updating the data files
You can refresh the domain information with the following command:
hdev run update-data
Setting up Your checkmatelib Development Environment
First you'll need to install:
- Git.
On Ubuntu:
sudo apt install git
, on macOS:brew install git
. - GNU Make.
This is probably already installed, run
make --version
to check. - pyenv. Follow the instructions in pyenv's README to install it. The Homebrew method works best on macOS. The Basic GitHub Checkout method works best on Ubuntu. You don't need to set up pyenv's shell integration ("shims"), you can use pyenv without shims.
Then to set up your development environment:
git clone https://github.com/hypothesis/checkmatelib.git
cd checkmatelib
make help
Releasing a New Version of the Project
-
First, to get PyPI publishing working you need to go to: https://github.com/organizations/hypothesis/settings/secrets/actions/PYPI_TOKEN and add checkmatelib to the
PYPI_TOKEN
secret's selected repositories. -
Now that the checkmatelib project has access to the
PYPI_TOKEN
secret you can release a new version by just creating a new GitHub release. Publishing a new GitHub release will automatically trigger a GitHub Actions workflow that will build the new version of your Python package and upload it to https://pypi.org/project/checkmatelib.
Changing the Project's Python Versions
To change what versions of Python the project uses:
-
Change the Python versions in the cookiecutter.json file. For example:
"python_versions": "3.10.4, 3.9.12",
-
Re-run the cookiecutter template:
make template
-
Commit everything to git and send a pull request
Changing the Project's Python Dependencies
To change the production dependencies in the setup.cfg
file:
-
Change the dependencies in the
.cookiecutter/includes/setuptools/install_requires
file. If this file doesn't exist yet create it and add some dependencies to it. For example:pyramid sqlalchemy celery
-
Re-run the cookiecutter template:
make template
-
Commit everything to git and send a pull request
To change the project's formatting, linting and test dependencies:
-
Change the dependencies in the
.cookiecutter/includes/tox/deps
file. If this file doesn't exist yet create it and add some dependencies to it. Use tox's factor-conditional settings to limit which environment(s) each dependency is used in. For example:lint: flake8, format: autopep8, lint,tests: pytest-faker,
-
Re-run the cookiecutter template:
make template
-
Commit everything to git and send a pull request
Project details
Release history Release notifications | RSS feed
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 checkmatelib-1.0.17.tar.gz
.
File metadata
- Download URL: checkmatelib-1.0.17.tar.gz
- Upload date:
- Size: 118.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b12afa57471a70c2b767dcb063db91a009d91d5859f73f39b0aa3d9060ec90e |
|
MD5 | 6d9c7ed5a377db3b475910ddfff8df0e |
|
BLAKE2b-256 | b1984391010f24ff152ad811b8b1d6393ce1bbe3a02731f3d64cf831b962f470 |
File details
Details for the file checkmatelib-1.0.17-py3-none-any.whl
.
File metadata
- Download URL: checkmatelib-1.0.17-py3-none-any.whl
- Upload date:
- Size: 105.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c5b60ea946396b6937210143a2142ee026cc3c22d85315f0597d169eef454ba |
|
MD5 | 2ea9891a9272b2db3a1de81b0750cb9a |
|
BLAKE2b-256 | 4e93a88fec112b4dd473ff95a96dcc7c7a8c7424f7de4ba4458b749654b638bb |