pip editable installation and installation from commit broken?

[fwitte]

I am trying to install furo on my machine:

First installation seems to be broken due to the emoji in the readme.md (https://codepoints.net/U+1F389), which happened both with the editable installation and the local clone as well as the installation from the commit.

(tespy-env) PS C:\Users\witt_fa\GitHub\tespy> pip install git+https://github.com/fwitte/furo@ceaeb12
Collecting git+https://github.com/fwitte/furo@ceaeb12
  Cloning https://github.com/fwitte/furo (to revision ceaeb12) to c:\users\witt_fa\appdata\local\temp\pip-req-build-gxnmns2z
  Running command git clone --filter=blob:none --quiet https://github.com/fwitte/furo 'C:\Users\witt_fa\AppData\Local\Temp\pip-req-build-gxnmns2z'
  WARNING: Did not find branch or tag 'ceaeb12', assuming revision or ref.
  Running command git checkout -q ceaeb12
  Resolved https://github.com/fwitte/furo to commit ceaeb12
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... error
  error: subprocess-exited-with-error

  × Preparing metadata (pyproject.toml) did not run successfully.
  │ exit code: 1
  ╰─> [21 lines of output]
      Traceback (most recent call last):
        File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_vendor\pyproject_hooks\_in_process\_in_process.py", line 353, in <module>
          main()
        File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_vendor\pyproject_hooks\_in_process\_in_process.py", line 335, in main
          json_out['return_val'] = hook(**hook_input['kwargs'])
                                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_vendor\pyproject_hooks\_in_process\_in_process.py", line 149, in prepare_metadata_for_build_wheel
          return hook(metadata_directory, config_settings)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "C:\Users\witt_fa\AppData\Local\Temp\pip-build-env-s7escza4\overlay\Lib\site-packages\sphinx_theme_builder\__init__.py", 
line 80, in prepare_metadata_for_build_wheel
          return _generate_metadata(project, destination=Path(metadata_directory))
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "C:\Users\witt_fa\AppData\Local\Temp\pip-build-env-s7escza4\overlay\Lib\site-packages\sphinx_theme_builder\_internal\distributions.py", line 132, in generate_metadata
          (dist_info / "METADATA").write_text(project.get_metadata_file_contents())
          return f.write(data)
                 ^^^^^^^^^^^^^
        File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\encodings\cp1252.py", line 19, in encode
          return codecs.charmap_encode(input,self.errors,encoding_table)[0]
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
      UnicodeEncodeError: 'charmap' codec can't encode character '\U0001f389' in position 3872: character maps to <undefined>
      [end of output]

  note: This error originates from a subprocess, and is likely not a problem with pip.
error: metadata-generation-failed

× Encountered error while generating package metadata.
╰─> See above for output.

note: This is an issue with the package mentioned above, not pip.
hint: See above for details.

After removing that there seems to be some kind of ASCII character remaining inside the readme.md (0x92), which I was not able to spot.

(tespy-env) PS C:\Users\witt_fa\GitHub\tespy> pip install -e ..\furo\
Obtaining file:///C:/Users/witt_fa/GitHub/furo
  Installing build dependencies ... done
  Checking if build backend supports build_editable ... done
  Getting requirements to build editable ... done
  Preparing editable metadata (pyproject.toml) ... done
ERROR: Exception:
Traceback (most recent call last):
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\cli\base_command.py", line 180, in exc_logging_wrapper 
    status = run_func(*args)
             ^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\cli\req_command.py", line 248, in wrapper
    return func(self, options, args)
           ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\commands\install.py", line 377, in run
    requirement_set = resolver.resolve(
                      ^^^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\resolution\resolvelib\resolver.py", line 73, in resolve    collected = self.factory.collect_root_requirements(root_reqs)
                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\resolution\resolvelib\factory.py", line 491, in collect_root_requirements
    req = self._make_requirement_from_install_req(
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\resolution\resolvelib\factory.py", line 453, in _make_requirement_from_install_req
    cand = self._make_candidate_from_link(
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\resolution\resolvelib\factory.py", line 185, in _make_candidate_from_link
    self._editable_candidate_cache[link] = EditableCandidate(
                                           ^^^^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\resolution\resolvelib\candidates.py", line 318, in __init__
    super().__init__(
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\resolution\resolvelib\candidates.py", line 156, in __init__
    self.dist = self._prepare()
                ^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\resolution\resolvelib\candidates.py", line 225, in _prepare
    dist = self._prepare_distribution()
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\resolution\resolvelib\candidates.py", line 328, in _prepare_distribution
    return self._factory.preparer.prepare_editable_requirement(self._ireq)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\operations\prepare.py", line 709, in prepare_editable_requirement
    dist = _get_prepared_distribution(
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\operations\prepare.py", line 69, in _get_prepared_distribution
    abstract_dist.prepare_distribution_metadata(
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\distributions\sdist.py", line 61, in prepare_distribution_metadata
    self.req.prepare_metadata()
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\req\req_install.py", line 578, in prepare_metadata     
    self._set_requirement()
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\req\req_install.py", line 371, in _set_requirement     
    assert self.metadata is not None
           ^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\req\req_install.py", line 587, in metadata
    self._metadata = self.get_dist().metadata
                     ^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\metadata\base.py", line 406, in metadata
    return self._metadata_cached()
           ^^^^^^^^^^^^^^^^^^^^^^^
    metadata = self._metadata_impl()
               ^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\site-packages\pip\_internal\metadata\importlib\_dists.py", line 208, in _metadata_impl
    return cast(email.message.Message, self._dist.metadata)
                                       ^^^^^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\importlib\metadata\__init__.py", line 610, in metadata
    self.read_text('METADATA')
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\importlib\metadata\__init__.py", line 938, in read_text
    return self._path.joinpath(filename).read_text(encoding='utf-8')
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\witt_fa\.conda\envs\tespy-env\Lib\pathlib.py", line 1059, in read_text
    return f.read()
           ^^^^^^^^
  File "<frozen codecs>", line 322, in decode
UnicodeDecodeError: 'utf-8' codec can't decode byte 0x92 in position 5590: invalid start byte

Therefore, I deleted the readme contents completely and the installation works fine. Am I doing something wrong?

Thank you!

[fwitte]

I am getting the same error with a fresh environment and the installation from your github on python 3.10 and also python 3.11

(test-furo) PS C:\Users\witt_fa\GitHub\tespy> pip install https://github.com/pradyunsg/furo/archive/refs/heads/main.zip
Collecting https://github.com/pradyunsg/furo/archive/refs/heads/main.zip
  Using cached https://github.com/pradyunsg/furo/archive/refs/heads/main.zip
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... error
  error: subprocess-exited-with-error

  × Preparing metadata (pyproject.toml) did not run successfully.
  │ exit code: 1
  ╰─> [16 lines of output]
      Traceback (most recent call last):
        File "C:\Users\witt_fa\.conda\envs\test-furo\lib\site-packages\pip\_vendor\pyproject_hooks\_in_process\_in_process.py", line 353, in <module>
          main()
        File "C:\Users\witt_fa\.conda\envs\test-furo\lib\site-packages\pip\_vendor\pyproject_hooks\_in_process\_in_process.py", line 335, in main
          json_out['return_val'] = hook(**hook_input['kwargs'])
        File "C:\Users\witt_fa\.conda\envs\test-furo\lib\site-packages\pip\_vendor\pyproject_hooks\_in_process\_in_process.py", line 149, in prepare_metadata_for_build_wheel
          return hook(metadata_directory, config_settings)
        File "C:\Users\witt_fa\AppData\Local\Temp\pip-build-env-cqhehyor\overlay\Lib\site-packages\sphinx_theme_builder\__init__.py", 
line 80, in prepare_metadata_for_build_wheel
          return _generate_metadata(project, destination=Path(metadata_directory))
        File "C:\Users\witt_fa\AppData\Local\Temp\pip-build-env-cqhehyor\overlay\Lib\site-packages\sphinx_theme_builder\_internal\dist          (dist_info / "METADATA").write_text(project.get_metadata_file_contents())
        File "C:\Users\witt_fa\.conda\envs\test-furo\lib\pathlib.py", line 1155, in write_text
          return f.write(data)
        File "C:\Users\witt_fa\.conda\envs\test-furo\lib\encodings\cp1252.py", line 19, in encode
          return codecs.charmap_encode(input,self.errors,encoding_table)[0]
      UnicodeEncodeError: 'charmap' codec can't encode character '\U0001f389' in position 3872: character maps to <undefined>
      [end of output]

  note: This error originates from a subprocess, and is likely not a problem with pip.
error: metadata-generation-failed

× Encountered error while generating package metadata.
╰─> See above for output.

note: This is an issue with the package mentioned above, not pip.
hint: See above for details.