Skip to content

pip-tools is missing a lot of practical documentation #1794

@Kache

Description

@Kache

Coming from having experience with poetry and bundler from Ruby, I'm finding it frustrating to get started with pip-tools. As far as I can tell, the only docs available are:

A synopsis of my experience follows.

Environment Versions

  1. OS Type: OSX
  2. Python version: Python 3.11.1
  3. pip version: pip 22.3.1
  4. pip-tools version: pip-compile, version 6.12.1

Steps to replicate

I started out trying to use a pyproject.toml, as I heard pip-tools now supports it. I wasn't even able to get a minimal working project up and running:

[project]
name = "sandbox"
# dependencies = ["more-itertools"]

Which fails if the last line is uncommented, with no guidance as what to do:

❯ pip-compile -v --no-emit-index-url --resolver=backtracking pyproject.toml
Creating venv isolated environment...
Installing packages in isolated environment... (setuptools >= 40.8.0, wheel)
Getting build dependencies for wheel...
Backend subprocess exited when trying to invoke get_requires_for_build_wheel
Failed to parse /Users/REDACTED/sandbox/pyproject.toml

Adopting a pyproject.toml generated via poetry doesn't work either.

I was more successful with requirements.in, but have been unable to find mentions of or ways to do practical things like:

Expected result

...

Actual result

...

Metadata

Metadata

Assignees

No one assigned

    Labels

    PR wantedFeature is discussed or bug is confirmed, PR neededdocsDocumentation relatedgood first issueA good item for first time contributors to work onhelp wantedRequest help from the communitymaintenanceRelated to maintenance processes

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions