pypa / pypa/packaging

Add PEP 503 repository parsing

Open
#155 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
751
Forks
324
Avg merge
12h 58m
Merged PRs (30d)
3

Description

I'm looking at adding a new module, packaging.pep503 that will add utilities for parsing PEP 503 compliant repositories.

My biggest concern with doing this is that it requires a HTML5 parser. I'd plan on doing this by adding a dependency on html5lib, as there's no point in trying to write our own parser, but it's a pretty significant sized dependency (at least, compared to the packaging library itself). Is there any problem with adding html5lib as a dependency? Should we make it a soft dependency, only needed if the PEP 503 module is used, or is that too much complexity to be worth worrying about?

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

Start by reviewing PEP 503 and the proposed packaging.pep503 module. Investigate the html5lib dependency question and the project's existing dependency conventions before defining the parsing utilities. Done means the module's scope and dependency approach are agreed and the proposed repository parsing behavior is covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.