https://github.com/hypothesis/checkmatelib
Tools for interacting with the Checkmate URL checking service
https://github.com/hypothesis/checkmatelib
Last synced: 11 months ago
JSON representation
Tools for interacting with the Checkmate URL checking service
- Host: GitHub
- URL: https://github.com/hypothesis/checkmatelib
- Owner: hypothesis
- License: bsd-2-clause
- Created: 2020-11-18T14:46:44.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-06-13T14:48:46.000Z (about 1 year ago)
- Last Synced: 2025-07-14T20:55:46.315Z (12 months ago)
- Language: Python
- Size: 201 KB
- Stars: 2
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# checkmatelib
Tools for interacting with the Checkmate URL checking service.
Usage
-----
```python
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:
```shell
bin/run/update_data.sh
```
## Setting up Your checkmatelib Development Environment
First you'll need to install:
* [Git](https://git-scm.com/).
On Ubuntu: `sudo apt install git`, on macOS: `brew install git`.
* [GNU Make](https://www.gnu.org/software/make/).
This is probably already installed, run `make --version` to check.
* [pyenv](https://github.com/pyenv/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](https://github.com/pyenv/pyenv#using-pyenv-without-shims).
Then to set up your development environment:
```terminal
git clone https://github.com/hypothesis/checkmatelib.git
cd checkmatelib
make help
```
## Releasing a New Version of the Project
1. First, to get PyPI publishing working you need to go to:
and add checkmatelib to the `PYPI_TOKEN` secret's selected
repositories.
2. 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](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository).
Publishing a new GitHub release will automatically trigger
[a GitHub Actions workflow](.github/workflows/pypi.yml)
that will build the new version of your Python package and upload it to
.
## Changing the Project's Python Versions
To change what versions of Python the project uses:
1. Change the Python versions in the
[cookiecutter.json](.cookiecutter/cookiecutter.json) file. For example:
```json
"python_versions": "3.10.4, 3.9.12",
```
2. Re-run the cookiecutter template:
```terminal
make template
```
3. 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:
1. Change the dependencies in the [`.cookiecutter/includes/setuptools/install_requires`](.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
```
2. Re-run the cookiecutter template:
```terminal
make template
```
3. Commit everything to git and send a pull request
To change the project's formatting, linting and test dependencies:
1. Change the dependencies in the [`.cookiecutter/includes/tox/deps`](.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](https://tox.wiki/en/latest/config.html#factors-and-factor-conditional-settings)
to limit which environment(s) each dependency is used in.
For example:
```
lint: flake8,
format: autopep8,
lint,tests: pytest-faker,
```
2. Re-run the cookiecutter template:
```terminal
make template
```
3. Commit everything to git and send a pull request