python-poetry / python-poetry/poetry

repository source should support a file system link to a index file like pip's --index-url for usage without a web server

Open
#8,919 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/feature status/triage
Dominant language
Python
Stars
34.3k
Forks
2.5k
Avg merge
2d 19h
Merged PRs (30d)
30

Description

  • I have searched the issues of this repo and believe that this is not a duplicate.
  • I have searched the FAQ and general documentation and believe that my question is not already covered.

Feature Request

I somehow understand the discussions and reluctance here and here about pip's find-links and why it will not be added, even if this would be very useful for company repositories which don't want to maintain a webserver.

But pip --index-url allows to pass a local html file, like file:///c:/wheelhouse/simple/index.html or c:\wheelhouse\simple\index.html.

Tools like piprepo create a index.html file with links to the local file system.
This might not be as convenient as 'find-links', but it serves the same purpose.

Poetry's source could be able to deal with these these local files (Simple API Repository and Single Page Link Source).
A source could use the attribute path separate the use cases.

Examples for usage:

[[tool.poetry.source]]
name = "foo"
path = "file:///C:/wheelhouse/simple/index.html"

[[tool.poetry.source]]
name = "foo"
url = "C:\wheelhouse\simple\index.html"

[[tool.poetry.source]]
name = "foo"
url = "file:///C:/wheelhouse/simple/index.html"

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No implementation files, tests, or entry points are named in the issue. Start by tracing how Poetry parses and resolves tool.poetry.source entries, then review the linked discussions before deciding how local index files and path versus URL configuration should be handled. Done means a source can use the demonstrated local file forms without a web server, with coverage for the supported cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.