search

ml-tooling / lazydocs

📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.
MIT License
205 stars 38 forks source link

Local install fails due to bad version string #45

Closed ronny-rentner closed 1 year ago

ronny-rentner commented 1 year ago

The version string in _about.py is set to __version__ = "0.5.0-dev.bugfix"

This is causing a local install to fail:

pip install -e .
Defaulting to user installation because normal site-packages is not writeable
Obtaining file:///home/ronny/Projects/py/lazydocs
  Installing build dependencies ... done
  Checking if build backend supports build_editable ... done
  Getting requirements to build editable ... done
  Preparing editable metadata (pyproject.toml) ... done
Requirement already satisfied: typer in /home/ronny/.local/lib/python3.10/site-packages (from lazydocs===0.5.0-dev.bugfix) (0.7.0)
Requirement already satisfied: click<9.0.0,>=7.1.1 in /home/ronny/.local/lib/python3.10/site-packages (from typer->lazydocs===0.5.0-dev.bugfix) (8.1.3)
Building wheels for collected packages: lazydocs
  Building editable for lazydocs (pyproject.toml) ... done
  Created wheel for lazydocs: filename=lazydocs-0.5.0_dev.bugfix-0.editable-py3-none-any.whl size=7507 sha256=2e7e2db0870c4db46d7835ab7b0d332254a0bb1f77937c1e121d749bb2847329
  Stored in directory: /tmp/pip-ephem-wheel-cache-76bgkh38/wheels/be/58/4e/9b56ea8cf13cb4f82d2332c9d15c62432365e8066a6b70ac50
  WARNING: Built editable for lazydocs is invalid: Metadata 1.2 mandates PEP 440 version, but '0.5.0-dev.bugfix' is not
Failed to build lazydocs
ERROR: Could not build wheels for lazydocs, which is required to install pyproject.toml-based projects

If I change the version to __version__ = "0.5.0-dev" a local install does work:

pip install -e .
Defaulting to user installation because normal site-packages is not writeable
Obtaining file:///home/ronny/Projects/py/lazydocs
  Installing build dependencies ... done
  Checking if build backend supports build_editable ... done
  Getting requirements to build editable ... done
  Preparing editable metadata (pyproject.toml) ... done
Requirement already satisfied: typer in /home/ronny/.local/lib/python3.10/site-packages (from lazydocs==0.5.0.dev0) (0.7.0)
Requirement already satisfied: click<9.0.0,>=7.1.1 in /home/ronny/.local/lib/python3.10/site-packages (from typer->lazydocs==0.5.0.dev0) (8.1.3)
Building wheels for collected packages: lazydocs
  Building editable for lazydocs (pyproject.toml) ... done
  Created wheel for lazydocs: filename=lazydocs-0.5.0.dev0-0.editable-py3-none-any.whl size=7412 sha256=67d515b4c0123e874d03545f509f539d240f7096a6f48b4a764f1c3ec0ed1978
  Stored in directory: /tmp/pip-ephem-wheel-cache-ekjj5skk/wheels/be/58/4e/9b56ea8cf13cb4f82d2332c9d15c62432365e8066a6b70ac50
Successfully built lazydocs
Installing collected packages: lazydocs
  Attempting uninstall: lazydocs
    Found existing installation: lazydocs 0.5.0.dev0
    Uninstalling lazydocs-0.5.0.dev0:
      Successfully uninstalled lazydocs-0.5.0.dev0
Successfully installed lazydocs-0.5.0.dev0
github-actions[bot] commented 1 year ago

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days