Build not working with errors on python dep install

[willkara]

Tried to install on my Windows 11 machine as well as my WSL 24.04 setup.

0.333 Using CPython 3.11.13 interpreter at: /usr/local/bin/python3
0.333 Creating virtual environment at: .venv
0.464    Building image-gen-mcp @ file:///app
0.550 Downloading aiohttp (1.7MiB)
0.555 Downloading pydantic-core (1.9MiB)
0.555 Downloading ruff (11.1MiB)
0.558 Downloading pygments (1.2MiB)
0.560 Downloading pillow (6.3MiB)
0.946  Downloading pygments
1.013  Downloading aiohttp
1.024  Downloading pydantic-core
1.275  Downloading pillow
1.384  Downloading ruff
1.582   × Failed to build `image-gen-mcp @ file:///app`
1.582   ├─▶ The build backend returned an error
1.582   ╰─▶ Call to `hatchling.build.build_editable` failed (exit status: 1)
1.582
1.582       [stderr]
1.582       Traceback (most recent call last):
1.582         File "<string>", line 11, in <module>
1.582         File
1.582       "/root/.cache/uv/builds-v0/.tmpxtlEbu/lib/python3.11/site-packages/hatchling/build.py",
1.582       line 83, in build_editable
1.582           return os.path.basename(next(builder.build(directory=wheel_directory,
1.582       versions=['editable'])))
1.582
1.582       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1.582         File
1.582       "/root/.cache/uv/builds-v0/.tmpxtlEbu/lib/python3.11/site-packages/hatchling/builders/plugin/interface.py",
1.582       line 90, in build
1.582           self.metadata.validate_fields()
1.582         File
1.582       "/root/.cache/uv/builds-v0/.tmpxtlEbu/lib/python3.11/site-packages/hatchling/metadata/core.py",
1.582       line 266, in validate_fields
1.582           self.core.validate_fields()
1.582         File
1.582       "/root/.cache/uv/builds-v0/.tmpxtlEbu/lib/python3.11/site-packages/hatchling/metadata/core.py",
1.582       line 1366, in validate_fields
1.582           getattr(self, attribute)
1.582         File
1.582       "/root/.cache/uv/builds-v0/.tmpxtlEbu/lib/python3.11/site-packages/hatchling/metadata/core.py",
1.582       line 531, in readme
1.582           raise OSError(message)
1.582       OSError: Readme file does not exist: README.md
1.582
1.582       hint: This usually indicates a problem with the package or the build
1.582       environment.

I've tried every iteration of using the uv command, shell scripts ...etc, but it always comes to this error.

Please let me know if you need anymore debugging info.

[lansespirit]

Hi @willkara,

Thank you for reporting this issue! The problem has been identified and fixed.

Root Cause

The build was failing because the README.md file wasn't being included in the Docker build context. The build system (hatchling) requires this file as specified in pyproject.toml, but it was being excluded by .dockerignore.

Fix Applied

The following changes have been made in commit dbaee83:

1. Dockerfile (line 17): Added README.md to the COPY instruction

   COPY pyproject.toml uv.lock README.md ./

2. .dockerignore (line 14): Modified to include README.md despite the *.md exclusion

   # Documentation
   *.md
   docs/
   !README.md    # This ensures README.md is included
   

3. Additional optimization: Added --no-install-project flag to uv sync to avoid premature editable installation

Testing

The fix has been tested and the Docker build now completes successfully without the "Readme file does not exist" error.

You can pull the latest changes and rebuild:

git pull
docker build -t image-gen-mcp .

Please let me know if you encounter any other issues. Thank you for your patience!

[willkara]

Sweet, thanks! Sorry I didn't submit a PR myself but the "issue" seemed to be too simple, I was sure I was missing something lol. Will try it out later!