Known issues

Here is a collection of known issues and their solutions that you may encounter when using the project starter.


2024-03-04 Update

I’ve recently tried the pip installation of Hatch (version 1.9.3), and the issues I was experiencing with hatch-pip-compile appear to be fully resolved. As a result, the binary is no longer a strict requirement, and the issue I describe below should no longer be a concern. However, there is still an advantage to using the binary version: updating hatch is a simple as running the following command:

hatch self update

In my experience, the hatch-pip-compile plugin may not function properly if hatch is not installed using a binary. Therefore, ensure that you have the latest version of hatch (at least 1.8.0) and that you have installed it using the binary distribution.

hatch and pre-commit

If you encounter an error when trying to make a commit after installing the pre-commit hooks, the error message may look like this:

$ An unexpected error has occurred: PermissionError: [Errno 13] Permission denied: '/usr/local/hatch/bin/hatch' Check the log at /Users/tobi/.cache/pre-commit/pre-commit.log

To resolve this issue, you can change the owner of the hatch binary using the following command:

$ sudo chown $USER /usr/local/hatch/bin/hatch

If you are unsure of the location of your hatch binary, you can use the following command to change the owner:

$ sudo chown $USER $(which hatch)

pre-commit python version

If you encounter the following error:

RuntimeError: failed to find interpreter for Builtin discover of python_spec='python3.11'

You need to update the section below (located at the beginning of the .pre-commit-config.yaml file) to match the Python version in your virtual environment:

   python: python3.11 # TODO: Change this to match your virtual environment's Python version