Skip to main content

Tools for interacting with the Checkmate URL checking service

Project description

h-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")

except CheckmateException:
    ...   # To block or not to block?

if hits:
    print(hits.reason_codes)

Hacking

Installing checkmatelib in a development environment

You will need

  • Git

  • pyenv Follow the instructions in the pyenv README to install it. The Homebrew method works best on macOS. On Ubuntu follow the Basic GitHub Checkout method.

Clone the git repo

git clone https://github.com/hypothesis/checkmatelib.git

This will download the code into a checkmatelib directory in your current working directory. You need to be in the checkmatelib directory for the rest of the installation process:

cd checkmatelib

Run the tests

make test

That's it! You’ve finished setting up your checkmatelib development environment. Run make help to see all the commands that're available for linting, code formatting, packaging, etc.

Updating the Cookiecutter scaffolding

This project was created from the https://github.com/hypothesis/h-cookiecutter-pypackage/ template. If h-cookiecutter-pypackage itself has changed since this project was created, and you want to update this project with the latest changes, you can "replay" the cookiecutter over this project. Run:

make template

This will change the files in your working tree, applying the latest updates from the h-cookiecutter-pypackage template. Inspect and test the changes, do any fixups that are needed, and then commit them to git and send a pull request.

If you want make template to skip certain files, never changing them, add these files to "options.disable_replay" in .cookiecutter.json and commit that to git.

If you want make template to update a file that's listed in disable_replay simply delete that file and then run make template, it'll recreate the file for you.

Project details


Download files

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

Files for h-checkmatelib, version 1.0.3
Filename, size File type Python version Upload date Hashes
Filename, size h_checkmatelib-1.0.3-py2.py3-none-any.whl (6.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size h-checkmatelib-1.0.3.tar.gz (6.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page